Class yii\authclient\clients\Twitter
| 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',
],
],
]
// ...
]
Note: some auth workflows provided by Twitter, such as application-only authentication, uses OAuth 2 protocol and thus are impossible to be used with this class. You should use yii\authclient\clients\TwitterOAuth2 for these.
See also:
Public Properties
Public Methods
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| composeAuthorizationHeader() | Composes authorization header. | 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 |
| createHttpClient() | Creates HTTP client instance from reference or configuration. | yii\authclient\BaseOAuth |
| createSignatureMethod() | Creates signature method instance from its configuration. | yii\authclient\BaseOAuth |
| createToken() | Creates token from its configuration. | yii\authclient\BaseOAuth |
| defaultName() | Generates service name. | yii\authclient\clients\Twitter |
| defaultNormalizeUserAttributeMap() | Returns the default \yii\authclient\normalizeUserAttributeMap value. | yii\authclient\BaseClient |
| defaultRequestOptions() | Returns default HTTP request options. | yii\authclient\BaseOAuth |
| 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 |
| 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\BaseClient |
| getStateKeyPrefix() | Returns session key prefix, which is used to store internal states. | yii\authclient\BaseClient |
| initUserAttributes() | Initializes authenticated user attributes. | yii\authclient\clients\Twitter |
| normalizeUserAttributes() | Normalize given user attributes according to \yii\authclient\normalizeUserAttributeMap. | yii\authclient\BaseClient |
| removeState() | Removes persistent state value. | yii\authclient\BaseClient |
| restoreAccessToken() | Restores access token. | yii\authclient\BaseOAuth |
| saveAccessToken() | Saves token as persistent state. | yii\authclient\BaseOAuth |
| sendRequest() | Sends the given HTTP request, returning response data. | yii\authclient\BaseOAuth |
| setState() | Sets persistent state. | yii\authclient\BaseClient |
Property Details
Access token HTTP method.
OAuth access token URL.
API base URL. This field will be used as \yii\httpclient\Client::baseUrl value of \yii\authclient\clients\httpClient. Note: changing this property will take no effect after \yii\authclient\clients\httpClient is instantiated.
List of extra parameters, which should be used, while requesting user attributes from Twitter API. For example:
[
'include_email' => 'true'
]
See also https://dev.twitter.com/rest/reference/get/account/verify_credentials.
Authorize URL.
Request token HTTP method.
OAuth request token URL.
Method Details
Generates service name.
| protected string defaultName ( ) | ||
| return | string | Service name. |
|---|---|---|
Generates service title.
| protected string defaultTitle ( ) | ||
| return | string | Service title. |
|---|---|---|
Initializes authenticated user attributes.
| protected array initUserAttributes ( ) | ||
| return | array | Auth user attributes. |
|---|---|---|