\Social\ProvidersTwitterProvider

Class GoogleProvider Social Media OAuth1 provider for TWITTER

Summary

Methods
Properties
Constants
__construct()
getRedirectRoute()
sendClientRequest()
No public properties found
No constants found
setProviderName()
getCredentials()
checkCredentials()
makeRequest()
setDefaultParams()
buildAuthorisation()
getSignature()
getSignatureBaseString()
getNonce()
getTimestamp()
urlencodeRfc3986()
$baseUrl
$preUrl
$signatureMethod
$oauthVersion
$defaultParams
$action
N/A
No private methods found
No private properties found
N/A

Properties

$baseUrl

$baseUrl : string

TWITTER's base authorisation URL

Type

string

$preUrl

$preUrl : string

Part of URL to append

Type

string

$signatureMethod

$signatureMethod : string

Type of hash to use

Type

string

$oauthVersion

$oauthVersion : string

TWITTER API version

Type

string

$defaultParams

$defaultParams : array

Default parameters to use in the URL request

Type

array

$action

$action : string

social login or registration

Type

string

Methods

__construct()

__construct(\Social\Service\SocialManager  $socialManager) 

Constructor Instantiate class and pass Social manager and set the extending social provider name.

Parameters

\Social\Service\SocialManager $socialManager

getRedirectRoute()

getRedirectRoute(string  $callback) : string

Get the full redirect URL (including query string)

Parameters

string $callback

Returns

string —

full redirect URL

sendClientRequest()

sendClientRequest(string  $callback, array  $queryParams) : array

Send Client Request Form client request URL with query params and send via Zend Client

Parameters

string $callback

the callback URL

array $queryParams

parameters to append to end of callback URL

Returns

array —

that contains the user profile

setProviderName()

setProviderName() 

Set the provider name

getCredentials()

getCredentials(\Social\Providers\type  $queryParams) : \Social\Providers\type

Get TWITTER user's credentials

Parameters

\Social\Providers\type $queryParams

Throws

\Exception

Returns

\Social\Providers\type

checkCredentials()

checkCredentials(array  $queryParams) : \Social\Providers\JSON

CHeck that the returned array has the required keys

Parameters

array $queryParams

Throws

\Exception

when returned object does not conform to requirements

Returns

\Social\Providers\JSON —

object

makeRequest()

makeRequest(string  $path, string  $method, array  $params = array(), string  $tokenSecret = '') : \Social\Providers\Response

Make HTTP request

Parameters

string $path
string $method
array $params
string $tokenSecret

Returns

\Social\Providers\Response

setDefaultParams()

setDefaultParams(string|false  $oauthToken = false, string|false  $oauthVerifier = false) 

Populate defaultParams with TWITTER specific values

Parameters

string|false $oauthToken
string|false $oauthVerifier

buildAuthorisation()

buildAuthorisation(string  $path, string  $method, string  $tokenSecret = '', array  $params = array()) : string

Build special authorisation hashed string specific to twitter

Parameters

string $path
string $method
string $tokenSecret
array $params

Throws

\Social\Providers\TwitterOAuthException

Returns

string

getSignature()

getSignature(array  $params, string  $path, string  $method, string  $tokenSecret = '') : string

Get specially constructed hashed string for TWITTER

Parameters

array $params
string $path
string $method
string $tokenSecret

Returns

string

getSignatureBaseString()

getSignatureBaseString(array  $params, string  $path, string  $method) : string

Get special query string ordered appropriately

Parameters

array $params
string $path
string $method

Returns

string

getNonce()

getNonce() : string

Get hashed string

Returns

string

getTimestamp()

getTimestamp() : string

Get time stamp

Returns

string

urlencodeRfc3986()

urlencodeRfc3986(array|string  $input) : string

Special URL encoding

Parameters

array|string $input

Returns

string