Класс yii\authclient\clients\GitHub
| Наследование | yii\authclient\clients\GitHub » 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/GitHub.php |
GitHub позволяет аутентификацию через GitHub OAuth.
Для использования GitHub OAuth необходимо зарегистрировать ваше приложение на https://github.com/settings/applications/new.
Пример конфигурации приложения:
'components' => [
'authClientCollection' => [
'class' => 'yii\authclient\Collection',
'clients' => [
'github' => [
'class' => 'yii\authclient\clients\GitHub',
'clientId' => 'github_client_id',
'clientSecret' => 'github_client_secret',
],
],
]
...
]
См. также:
Публичные свойства
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\GitHub |
| 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 |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| 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\GitHub |
| defaultNormalizeUserAttributeMap() | Возвращает значение по умолчанию $normalizeUserAttributeMap. | yii\authclient\BaseClient |
| defaultRequestOptions() | Возвращает параметры HTTP-запроса по умолчанию. | yii\authclient\BaseOAuth |
| defaultReturnUrl() | Формирует значение по умолчанию $returnUrl. | yii\authclient\OAuth2 |
| defaultTitle() | Генерирует заголовок сервиса. | yii\authclient\clients\GitHub |
| defaultViewOptions() | Возвращает значение по умолчанию $viewOptions. | yii\authclient\BaseClient |
| generateAuthState() | Генерирует значение состояния авторизации. | yii\authclient\OAuth2 |
| getState() | Возвращает значение состояния в постоянном хранилище. | yii\authclient\BaseClient |
| getStateKeyPrefix() | Возвращает префикс ключа сессии, который используется для хранения внутренних состояний. | yii\authclient\BaseClient |
| initUserAttributes() | Инициализирует атрибуты аутентифицированного пользователя. | yii\authclient\clients\GitHub |
| 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://api.github.com'
$authUrl общедоступное свойство
URL авторизации.
public string $authUrl = 'https://github.com/login/oauth/authorize'
$tokenUrl общедоступное свойство
Конечная точка для запроса токена.
public string $tokenUrl = 'https://github.com/login/oauth/access_token'
Подробное описание методов
defaultName() защищённый метод
Генерирует имя сервиса.
| protected string defaultName ( ) | ||
|---|---|---|
| return | string |
Имя сервиса. |
defaultTitle() защищённый метод
Генерирует заголовок сервиса.
| protected string defaultTitle ( ) | ||
|---|---|---|
| return | string |
Заголовок сервиса. |
init() общедоступный метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) |
|---|
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-github.html
