Класс yii\authclient\clients\Twitter
| Наследование | yii\authclient\clients\Twitter » yii\authclient\OAuth1 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\authclient\ClientInterface, yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/clients/Twitter.php |
Twitter позволяет аутентификацию через Twitter OAuth.
Для использования Twitter OAuth необходимо зарегистрировать ваше приложение по адресу https://dev.twitter.com/apps/new.
Пример конфигурации приложения:
'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',
],
],
]
...
]
См. также https://apps.twitter.com/.
Общедоступные свойства
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в null. | yii\base\Component |
| api() | Выполняет запрос к API OAuth и возвращает данные ответа. | yii\authclient\BaseOAuth |
| applyAccessTokenToRequest() | Применяет токен доступа к экземпляру HTTP-запроса. | yii\authclient\OAuth1 |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeApiRequestSend() | Обрабатывает событие yii\httpclient\Request::EVENT_BEFORE_SEND. | yii\authclient\BaseOAuth |
| beforeRequestSend() | Обрабатывает событие yii\httpclient\Request::EVENT_BEFORE_SEND событие. | yii\authclient\OAuth1 |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| buildAuthUrl() | Создаёт URL авторизации пользователя. | yii\authclient\OAuth1 |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| createApiRequest() | Создаёт HTTP-запрос для вызова API. | yii\authclient\OAuth1 |
| createRequest() | Создаёт экземпляр HTTP-запроса. | yii\authclient\OAuth1 |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| fetchAccessToken() | Получает токен доступа OAuth. | yii\authclient\OAuth1 |
| fetchRequestToken() | Получает токен запроса OAuth. | yii\authclient\OAuth1 |
| getAccessToken() | yii\authclient\BaseOAuth | |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединённые к этому компоненту. | yii\base\Component |
| getHttpClient() | Возвращает HTTP-клиент. | yii\authclient\BaseClient |
| getId() | yii\authclient\ClientInterface | |
| getName() | yii\authclient\ClientInterface | |
| getNormalizeUserAttributeMap() | yii\authclient\BaseClient | |
| getRequestOptions() | yii\authclient\BaseClient | |
| getReturnUrl() | yii\authclient\BaseOAuth | |
| getSignatureMethod() | yii\authclient\BaseOAuth | |
| getStateStorage() | yii\authclient\BaseClient | |
| getTitle() | yii\authclient\ClientInterface | |
| getUserAttributes() | yii\authclient\ClientInterface | |
| getViewOptions() | yii\authclient\ClientInterface | |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикреплённый к событию с заданным именем. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| refreshAccessToken() | Получает новый токен аутентификации для замены истекшего. | yii\authclient\OAuth1 |
| setAccessToken() | Устанавливает токен доступа для использования. | yii\authclient\BaseOAuth |
| setHttpClient() | Устанавливает используемый HTTP-клиент. | yii\authclient\BaseOAuth |
| setId() | yii\authclient\ClientInterface | |
| setName() | yii\authclient\ClientInterface | |
| setNormalizeUserAttributeMap() | yii\authclient\BaseClient |
| setRequestOptions() | yii\authclient\BaseClient | |
| setReturnUrl() | yii\authclient\BaseOAuth | |
| setSignatureMethod() | Устанавливает метод подписи, который будет использоваться. | yii\authclient\BaseOAuth |
| setStateStorage() | yii\authclient\BaseClient | |
| setTitle() | yii\authclient\ClientInterface | |
| setUserAttributes() | yii\authclient\BaseClient | |
| setViewOptions() | yii\authclient\BaseClient | |
| signRequest() | Подписывает данный запрос с помощью $signatureMethod. | yii\authclient\OAuth1 |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| composeAuthorizationHeader() | Компонует заголовок авторизации. | yii\authclient\OAuth1 |
| composeSignatureBaseString() | Создаёт базовый строку подписи, которая будет подписана с помощью $signatureMethod. | yii\authclient\OAuth1 |
| composeSignatureKey() | Компонует ключ подписи запроса. | yii\authclient\OAuth1 |
| composeUrl() | Компонует URL из базового URL и GET-параметров. | yii\authclient\BaseOAuth |
| createHttpClient() | Создаёт экземпляр HTTP-клиента из ссылки или конфигурации. | yii\authclient\BaseOAuth |
| createSignatureMethod() | Создаёт экземпляр метода подписи из его конфигурации. | yii\authclient\BaseOAuth |
| createToken() | Создаёт токен из его конфигурации. | yii\authclient\BaseOAuth |
| defaultName() | Генерирует имя сервиса. | yii\authclient\clients\Twitter |
| defaultNormalizeUserAttributeMap() | Возвращает значение по умолчанию для $normalizeUserAttributeMap. | yii\authclient\BaseClient |
| defaultRequestOptions() | Возвращает значения по умолчанию для опций HTTP-запроса. | yii\authclient\BaseOAuth |
| defaultReturnUrl() | Компонует значение по умолчанию для $returnUrl. | yii\authclient\OAuth1 |
| defaultTitle() | Генерирует заголовок сервиса. | yii\authclient\clients\Twitter |
| defaultViewOptions() | Возвращает значение по умолчанию для $viewOptions. | yii\authclient\BaseClient |
| generateCommonRequestParams() | Генерирует общие параметры запроса, такие как версия, отметка времени и т.д. | yii\authclient\OAuth1 |
| generateNonce() | Генерирует значение nonce. | yii\authclient\OAuth1 |
| generateTimestamp() | Генерирует отметку времени. | yii\authclient\OAuth1 |
| getState() | Возвращает значение постоянного состояния. | yii\authclient\BaseClient |
| getStateKeyPrefix() | Возвращает префикс ключа сессии, используемый для хранения внутренних состояний. | yii\authclient\BaseClient |
| initUserAttributes() | Инициализирует атрибуты авторизованного пользователя. | yii\authclient\clients\Twitter |
| normalizeUserAttributes() | Нормализует заданные атрибуты пользователя в соответствии с $normalizeUserAttributeMap. | yii\authclient\BaseClient |
| removeState() | Удаляет значение постоянного состояния. | yii\authclient\BaseClient |
| restoreAccessToken() | Восстанавливает токен доступа. | yii\authclient\BaseOAuth |
| saveAccessToken() | Сохраняет токен как постоянное состояние. | yii\authclient\BaseOAuth |
| sendRequest() | Отправляет заданный HTTP-запрос, возвращая данные ответа. | yii\authclient\BaseOAuth |
| setState() | Устанавливает постоянное состояние. | yii\authclient\BaseClient |
Подробное описание свойств
$accessTokenMethod общедоступное свойство
HTTP-метод для получения токена доступа.
public string $accessTokenMethod = 'POST'
$accessTokenUrl общедоступное свойство
URL для получения токена доступа OAuth.
public string $accessTokenUrl = 'https://api.twitter.com/oauth/access_token'
$apiBaseUrl общедоступное свойство
Базовый URL API. Это поле будет использовано как значение yii\httpclient\Client::$baseUrl для $httpClient. Примечание: изменение этого свойства не будет иметь эффекта после создания экземпляра $httpClient.
public string $apiBaseUrl = 'https://api.twitter.com/1.1'
$attributeParams общедоступное свойство (доступно начиная с версии 2.0.6)
Список дополнительных параметров, которые должны быть использованы при запросе атрибутов пользователя от API Twitter. Например:
[
'include_email' => 'true'
]
См. также https://dev.twitter.com/rest/reference/get/account/verify_credentials.
public array $attributeParams = []
$authUrl общедоступное свойство
URL авторизации.
public string $authUrl = 'https://api.twitter.com/oauth/authenticate'
$requestTokenMethod общедоступное свойство
HTTP-метод для получения токена запроса.
public string $requestTokenMethod = 'POST'
$requestTokenUrl общедоступное свойство
URL для получения токена запроса OAuth.
public string $requestTokenUrl = 'https://api.twitter.com/oauth/request_token'
Подробное описание методов
defaultName() защищённый метод
Генерирует имя сервиса.
| защищённый string defaultName ( ) | ||
|---|---|---|
| return | string |
Имя сервиса. |
defaultTitle() защищённый метод
Генерирует заголовок сервиса.
| защищённый string defaultTitle ( ) | ||
|---|---|---|
| return | string |
Заголовок сервиса. |
initUserAttributes() защищённый метод
Инициализирует атрибуты аутентифицированного пользователя.
| защищённый array initUserAttributes ( ) | ||
|---|---|---|
| return | array |
Атрибуты пользователя авторизации. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-clients-twitter.html