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

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

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

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

Для использования Microsoft Live OAuth необходимо зарегистрировать ваше приложение по адресу https://account.live.com/developers/applications

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

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'live' => [
                'class' => 'yii\authclient\clients\Live',
                'clientId' => 'live_client_id',
                'clientSecret' => 'live_client_secret',
            ],
        ],
    ]
    ...
]

См. также:

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

Свойство	Тип	Описание	Определено в
$accessToken	массив\|yii\authclient\OAuthToken	Токен доступа или его конфигурация.	yii\authclient\BaseOAuth
$apiBaseUrl	строка	Базовый URL API.	yii\authclient\clients\Live
$authUrl	строка	URL авторизации.	yii\authclient\clients\Live
$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\Live
$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\OAuth2
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\authclient\clients\Live
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\Live
defaultNormalizeUserAttributeMap()	Возвращает значение по умолчанию для $normalizeUserAttributeMap.	yii\authclient\BaseClient
defaultRequestOptions()	Возвращает параметры HTTP-запроса по умолчанию.	yii\authclient\BaseOAuth
defaultReturnUrl()	Компонует значение по умолчанию для $returnUrl.	yii\authclient\OAuth2
defaultTitle()	Генерирует заголовок сервиса.	yii\authclient\clients\Live
defaultViewOptions()	Возвращает значение по умолчанию для $viewOptions.	yii\authclient\BaseClient
generateAuthState()	Генерирует значение состояния авторизации.	yii\authclient\OAuth2
getState()	Возвращает значение состояния.	yii\authclient\BaseClient
getStateKeyPrefix()	Возвращает префикс ключа сессии, который используется для хранения внутренних состояний.	yii\authclient\BaseClient
initUserAttributes()	Инициализирует атрибуты авторизованного пользователя.	yii\authclient\clients\Live
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://apis.live.net/v5.0'

$authUrl общедоступное свойство

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

public string $authUrl = 'https://login.live.com/oauth20_authorize.srf'

$tokenUrl общедоступное свойство

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

public string $tokenUrl = 'https://login.live.com/oauth20_token.srf'

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

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

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

защищённый string defaultName ( )
возвращает	string	Имя сервиса.

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

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

защищённый string defaultTitle ( )
возвращает	string	Заголовок сервиса.

init() общедоступный метод

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта с заданной конфигурацией.

общедоступный void init ( )

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

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

защищённый array initUserAttributes ( )
возвращает	array	Атрибуты пользователя.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-clients-live.html