Class yii\authclient\clients\Twitter

All Classes | Properties | Methods | Constants

Inheritance	yii\authclient\clients\Twitter » yii\authclient\OAuth1 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component
Implements	yii\authclient\ClientInterface
Available since version	2.0

Twitter allows authentication via Twitter OAuth.

In order to use Twitter OAuth you must register your application at https://dev.twitter.com/apps/new.

Example application configuration:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'twitter' => [
                'class' => 'yii\authclient\clients\Twitter',
                'attributeParams' => [
                    'include_email' => 'true'
                ],
                'consumerKey' => 'twitter_consumer_key',
                'consumerSecret' => 'twitter_consumer_secret',
            ],
        ],
    ]
    ...
]

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$accessTokenMethod	string	Access token HTTP method.	yii\authclient\clients\Twitter
$accessTokenUrl	string	OAuth access token URL.	yii\authclient\clients\Twitter
$apiBaseUrl	string	API base URL.	yii\authclient\clients\Twitter
$attributeParams	array	List of extra parameters, which should be used, while requesting user attributes from Twitter API.	yii\authclient\clients\Twitter
$authUrl	string	Authorize URL.	yii\authclient\clients\Twitter
$autoRefreshAccessToken	boolean	Whether to automatically perform 'refresh access token' request on expired access token.	yii\authclient\BaseOAuth
$consumerKey	string	OAuth consumer key.	yii\authclient\OAuth1
$consumerSecret	string	OAuth consumer secret.	yii\authclient\OAuth1
$requestTokenMethod	string	Request token HTTP method.	yii\authclient\clients\Twitter
$requestTokenUrl	string	OAuth request token URL.	yii\authclient\clients\Twitter
$scope	string	Auth request scope.	yii\authclient\BaseOAuth
$version	string	Protocol version.	yii\authclient\OAuth1

Public Methods

Hide inherited methods

Method	Description	Defined By
api()	Performs request to the OAuth API.	yii\authclient\BaseOAuth
buildAuthUrl()	Composes user authorization URL.	yii\authclient\OAuth1
fetchAccessToken()	Fetches OAuth access token.	yii\authclient\OAuth1
fetchRequestToken()	Fetches the OAuth request token.	yii\authclient\OAuth1
getAccessToken()		yii\authclient\BaseOAuth
getCurlOptions()		yii\authclient\BaseOAuth
getId()		yii\authclient\ClientInterface
getName()		yii\authclient\ClientInterface
getNormalizeUserAttributeMap()		yii\authclient\BaseClient
getReturnUrl()		yii\authclient\BaseOAuth
getSignatureMethod()		yii\authclient\BaseOAuth
getTitle()		yii\authclient\ClientInterface
getUserAttributes()		yii\authclient\ClientInterface
getViewOptions()		yii\authclient\ClientInterface
refreshAccessToken()	Gets new auth token to replace expired one.	yii\authclient\OAuth1
setAccessToken()		yii\authclient\BaseOAuth
setCurlOptions()		yii\authclient\BaseOAuth
setId()		yii\authclient\ClientInterface
setName()		yii\authclient\ClientInterface
setNormalizeUserAttributeMap()		yii\authclient\BaseClient
setReturnUrl()		yii\authclient\BaseOAuth
setSignatureMethod()		yii\authclient\BaseOAuth
setTitle()		yii\authclient\ClientInterface
setUserAttributes()		yii\authclient\BaseClient
setViewOptions()		yii\authclient\BaseClient

Protected Methods

Hide inherited methods

Method	Description	Defined By
apiInternal()	Performs request to the OAuth API.	yii\authclient\OAuth1
composeAuthorizationHeader()	Composes authorization header content.	yii\authclient\OAuth1
composeRequestCurlOptions()	Composes HTTP request CUrl options, which will be merged with the default ones.	yii\authclient\OAuth1
composeSignatureBaseString()	Creates signature base string, which will be signed by \yii\authclient\signatureMethod.	yii\authclient\OAuth1
composeSignatureKey()	Composes request signature key.	yii\authclient\OAuth1
composeUrl()	Composes URL from base URL and GET params.	yii\authclient\BaseOAuth
convertXmlToArray()	Converts XML document to array.	yii\authclient\BaseOAuth
createSignatureMethod()	Creates signature method instance from its configuration.	yii\authclient\BaseOAuth
createToken()	Creates token from its configuration.	yii\authclient\BaseOAuth
defaultCurlOptions()	Returns default cURL options.	yii\authclient\BaseOAuth
defaultName()	Generates service name.	yii\authclient\clients\Twitter
defaultNormalizeUserAttributeMap()	Returns the default \yii\authclient\normalizeUserAttributeMap value.	yii\authclient\BaseClient
defaultReturnUrl()	Composes default \yii\authclient\returnUrl value.	yii\authclient\OAuth1
defaultTitle()	Generates service title.	yii\authclient\clients\Twitter
defaultViewOptions()	Returns the default \yii\authclient\viewOptions value.	yii\authclient\BaseClient
determineContentTypeByHeaders()	Attempts to determine HTTP request content type by headers.	yii\authclient\BaseOAuth
determineContentTypeByRaw()	Attempts to determine the content type from raw content.	yii\authclient\BaseOAuth
generateCommonRequestParams()	Generate common request params like version, timestamp etc.	yii\authclient\OAuth1
generateNonce()	Generates nonce value.	yii\authclient\OAuth1
generateTimestamp()	Generates timestamp.	yii\authclient\OAuth1
getState()	Returns persistent state value.	yii\authclient\BaseOAuth
getStateKeyPrefix()	Returns session key prefix, which is used to store internal states.	yii\authclient\BaseOAuth
initUserAttributes()	Initializes authenticated user attributes.	yii\authclient\clients\Twitter
mergeCurlOptions()	Merge CUrl options.	yii\authclient\BaseOAuth
normalizeUserAttributes()	Normalize given user attributes according to \yii\authclient\normalizeUserAttributeMap.	yii\authclient\BaseClient
processResponse()	Processes raw response converting it to actual data.	yii\authclient\BaseOAuth
removeState()	Removes persistent state value.	yii\authclient\BaseOAuth
restoreAccessToken()	Restores access token.	yii\authclient\BaseOAuth
saveAccessToken()	Saves token as persistent state.	yii\authclient\BaseOAuth
sendRequest()	Sends HTTP request.	yii\authclient\BaseOAuth
sendSignedRequest()	Sends HTTP request, signed by \yii\authclient\signatureMethod.	yii\authclient\OAuth1
setState()	Sets persistent state.	yii\authclient\BaseOAuth
signRequest()	Sign request with \yii\authclient\signatureMethod.	yii\authclient\OAuth1

Constants

Hide inherited constants

Constant	Value	Defined By
CONTENT_TYPE_AUTO	'auto'	yii\authclient\BaseOAuth
CONTENT_TYPE_JSON	'json'	yii\authclient\BaseOAuth
CONTENT_TYPE_URLENCODED	'urlencoded'	yii\authclient\BaseOAuth
CONTENT_TYPE_XML	'xml'	yii\authclient\BaseOAuth

Property Details

$accessTokenMethod public property

Access token HTTP method.

public string $accessTokenMethod = 'POST'

$accessTokenUrl public property

OAuth access token URL.

public string $accessTokenUrl = 'https://api.twitter.com/oauth/access_token'

$apiBaseUrl public property

API base URL.

public string $apiBaseUrl = 'https://api.twitter.com/1.1'

$attributeParams public property (available since version 2.0.6)

List of extra parameters, which should be used, while requesting user attributes from Twitter API. For example:

[
    'include_email' => 'true'
]

public array $attributeParams = []

$authUrl public property

Authorize URL.

public string $authUrl = 'https://api.twitter.com/oauth/authenticate'

$requestTokenMethod public property

Request token HTTP method.

public string $requestTokenMethod = 'POST'

$requestTokenUrl public property

OAuth request token URL.

public string $requestTokenUrl = 'https://api.twitter.com/oauth/request_token'

Method Details

defaultName() protected method

Generates service name.

protected string defaultName ( )
return	string	Service name.

defaultTitle() protected method

Generates service title.

protected string defaultTitle ( )
return	string	Service title.

initUserAttributes() protected method

Initializes authenticated user attributes.

protected array initUserAttributes ( )
return	array	Auth user attributes.