Класс yii\authclient\clients\Yandex

Все классы | Свойства | Методы

Наследование	yii\authclient\clients\Yandex » yii\authclient\OAuth2 » 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/Yandex.php

Yandex позволяет аутентификацию через Yandex OAuth.

Для использования Yandex OAuth необходимо зарегистрировать ваше приложение по адресу https://oauth.yandex.ru/client/new.

Пример конфигурации приложения:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'yandex' => [
                'class' => 'yii\authclient\clients\Yandex',
                'clientId' => 'yandex_client_id',
                'clientSecret' => 'yandex_client_secret',
            ],
        ],
    ]
    ...
]

См. также:

Публичные свойства

Свойство	Тип	Описание	Определено в
$accessToken	массив\|yii\authclient\OAuthToken	Токен доступа или его конфигурация.	yii\authclient\BaseOAuth
$apiBaseUrl	строка	Базовый URL API.	yii\authclient\clients\Yandex
$authUrl	строка	URL авторизации.	yii\authclient\clients\Yandex
$autoRefreshAccessToken	булево	Автоматически выполнять запрос «обновления токена доступа» при истечении срока действия токена доступа.	yii\authclient\BaseOAuth
$behaviors	yii\base\Behavior[]	Список присоединенных к этому компоненту поведений.	yii\base\Component
$clientId	строка	Идентификатор клиента OAuth.	yii\authclient\OAuth2
$clientSecret	строка	Секрет клиента OAuth.	yii\authclient\OAuth2
$httpClient	yii\httpclient\Client	Внутренний HTTP-клиент.	yii\authclient\BaseClient
$id	строка	Идентификатор сервиса.	yii\authclient\ClientInterface
$name	строка	Имя сервиса.	yii\authclient\ClientInterface
$normalizeUserAttributeMap	массив	Карта нормализации атрибутов пользователя.	yii\authclient\BaseClient
$requestOptions	массив	Параметры HTTP-запроса.	yii\authclient\BaseClient
$returnUrl	строка	URL возврата	yii\authclient\BaseOAuth
$scope	строка	Область запроса авторизации.	yii\authclient\BaseOAuth
$signatureMethod	массив\|yii\authclient\signature\BaseMethod	Экземпляр метода подписи или его конфигурация в виде массива.	yii\authclient\BaseOAuth
$stateStorage	yii\authclient\StateStorageInterface	Хранилище состояния.	yii\authclient\BaseClient
$title	строка	Название сервиса.	yii\authclient\ClientInterface
$tokenUrl	строка	Конечная точка запроса токена.	yii\authclient\clients\Yandex
$userAttributes	массив	Список атрибутов пользователя.	yii\authclient\BaseClient
$validateAuthState	булево	Использовать и проверять параметр 'state' авторизации в процессе авторизации.	yii\authclient\OAuth2
$version	строка	Версия протокола.	yii\authclient\OAuth2
$viewOptions	массив	Параметры отображения в формате: имя_параметра => значение_параметра	yii\authclient\BaseClient

Публичные методы

Метод	Описание	Определено в
__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\clients\Yandex
attachBehavior()	Присоединяет поведение к данному компоненту.	yii\base\Component
attachBehaviors()	Присоединяет список поведений к компоненту.	yii\base\Component
authenticateClient()	Авторизует клиента OAuth напрямую у провайдера без участия третьей стороны (пользователя), используя тип предоставления "client_credentials".	yii\authclient\OAuth2
authenticateUser()	Авторизует пользователя напрямую по паре "имя пользователя/пароль", используя тип предоставления "password".	yii\authclient\OAuth2
authenticateUserJwt()	Авторизует пользователя напрямую с помощью JSON Web Token (JWT).	yii\authclient\OAuth2
beforeApiRequestSend()	Обрабатывает событие yii\httpclient\Request::EVENT_BEFORE_SEND.	yii\authclient\BaseOAuth
behaviors()	Возвращает список поведений, по которым должен вести себя этот компонент.	yii\base\Component
buildAuthUrl()	Создаёт URL для авторизации пользователя.	yii\authclient\OAuth2
canGetProperty()	Возвращает значение, указывающее, можно ли считать свойство.	yii\base\Component
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Component
className()	Возвращает полное имя этого класса.	yii\base\Object
createApiRequest()	Создаёт HTTP-запрос для вызова API.	yii\authclient\BaseOAuth
createRequest()	Создаёт экземпляр HTTP-запроса.	yii\authclient\BaseClient
detachBehavior()	Отсоединяет поведение от компонента.	yii\base\Component
detachBehaviors()	Отсоединяет все поведения от компонента.	yii\base\Component
ensureBehaviors()	Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту.	yii\base\Component
fetchAccessToken()	Получает токен доступа по коду авторизации.	yii\authclient\OAuth2
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\OAuth2
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
trigger()	Вызывает событие.	yii\base\Component

Защищенные методы

Метод	Описание	Определено в
applyClientCredentialsToRequest()	Применяет учетные данные клиента (например, $clientId и $clientSecret) к экземпляру HTTP-запроса.	yii\authclient\OAuth2
composeUrl()	Компонует URL из базового URL и параметров GET.	yii\authclient\BaseOAuth
createHttpClient()	Создаёт экземпляр HTTP-клиента по ссылке или конфигурации.	yii\authclient\BaseOAuth
createSignatureMethod()	Создаёт экземпляр метода подписи по его конфигурации.	yii\authclient\BaseOAuth
createToken()	Создаёт токен по его конфигурации.	yii\authclient\OAuth2
defaultName()	Генерирует имя сервиса.	yii\authclient\clients\Yandex
defaultNormalizeUserAttributeMap()	Возвращает значение по умолчанию $normalizeUserAttributeMap.	yii\authclient\BaseClient
defaultRequestOptions()	Возвращает значения HTTP-запросов по умолчанию.	yii\authclient\BaseOAuth
defaultReturnUrl()	Компонует значение по умолчанию $returnUrl.	yii\authclient\OAuth2
defaultTitle()	Генерирует заголовок сервиса.	yii\authclient\clients\Yandex
defaultViewOptions()	Возвращает значение по умолчанию $viewOptions.	yii\authclient\BaseClient
generateAuthState()	Генерирует значение состояния авторизации.	yii\authclient\OAuth2
getState()	Возвращает значение состояния.	yii\authclient\BaseClient
getStateKeyPrefix()	Возвращает префикс ключа сессии, используемый для хранения внутренних состояний.	yii\authclient\BaseClient
initUserAttributes()	Инициализирует атрибуты авторизованного пользователя.	yii\authclient\clients\Yandex
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

Подробное описание свойств

$apiBaseUrl общественное свойство

Базовый URL API. Это поле будет использовано как значение yii\httpclient\Client::$baseUrl для $httpClient. Примечание: изменение этого свойства не повлияет на результат после того, как $httpClient был инициализирован.

public string $apiBaseUrl = 'https://login.yandex.ru'

$authUrl общественное свойство

URL авторизации.

public string $authUrl = 'https://oauth.yandex.ru/authorize'

$tokenUrl общественное свойство

Конечная точка URL-адреса запроса токена.

public string $tokenUrl = 'https://oauth.yandex.ru/token'

Подробное описание методов

applyAccessTokenToRequest() общественный метод

Применяет токен доступа к экземпляру HTTP-запроса.

public void applyAccessTokenToRequest ( $request, $accessToken )
$request	yii\httpclient\Request	Экземпляр HTTP-запроса.
$accessToken	yii\authclient\OAuthToken	Экземпляр токена доступа.

defaultName() защищённый метод

Генерирует имя сервиса.

protected string defaultName ( )
return	string	Имя сервиса.

defaultTitle() защищённый метод

Генерирует заголовок сервиса.

protected string defaultTitle ( )
return	string	Заголовок сервиса.

initUserAttributes() защищённый метод

Инициализирует атрибуты авторизованного пользователя.

protected 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-yandex.html