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

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

Наследование	yii\authclient\clients\Google » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\Object
Реализует	yii\authclient\ClientInterface, yii\base\Configurable
Подклассы	yii\authclient\clients\GoogleHybrid
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2-authclient/blob/master/clients/Google.php

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

Для использования Google OAuth необходимо создать проект на https://console.developers.google.com/project и настроить его учетные данные по адресу https://console.developers.google.com/project/[yourProjectId]/apiui/credential. Для включения использования областей видимости (scopes) для получения атрибутов пользователя, также необходимо включить API Google+ по адресу https://console.developers.google.com/project/[yourProjectId]/apiui/api/plus

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

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'google' => [
                'class' => 'yii\authclient\clients\Google',
                'clientId' => 'google_client_id',
                'clientSecret' => 'google_client_secret',
            ],
        ],
    ]
    ...
]

См. также https://console.developers.google.com/project.

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

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

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

public string $apiBaseUrl = 'https://www.googleapis.com/plus/v1'

$authUrl свойство public

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

public string $authUrl = 'https://accounts.google.com/o/oauth2/auth'

$tokenUrl свойство public

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

public string $tokenUrl = 'https://accounts.google.com/o/oauth2/token'

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

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

Генерирует имя службы.

protected string defaultName ( )
return	string	Имя службы.

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

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

protected string defaultTitle ( )
return	string	Заголовок службы.

init() public метод

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

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

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-google.html