Spec-Zone.ru › Yii 2.0

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

Все классы | Свойства | Методы
Наследование yii\authclient\clients\GoogleHybrid » 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
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2-authclient/blob/master/clients/GoogleHybrid.php

GoogleHybrid — это улучшенная версия yii\authclient\clients\Google, использующая гибридный поток входа Google+, который полагается на встроенный JavaScript-код для создания кнопки входа.

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

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

Сама JavaScript-кнопка генерируется виджетом \yii\authclient\clients\yii\authclient\widgets\GooglePlusButton. Если вы используете \yii\authclient\clients\yii\authclient\widgets\AuthChoice, она появится автоматически. В противном случае вам нужно добавить её на страницу вручную. Вы можете настроить её внешний вид, используя ключ 'widget' в $viewOptions:

'google' => [
    ...
    'viewOptions' => [
        'widget' => [
            'class' => 'yii\authclient\widgets\GooglePlusButton',
            'buttonHtmlOptions' => [
                'data-approvalprompt' => 'force'
            ],
        ],
    ],
],

См. также:

  • yii\authclient\clients\Google
  • yii\authclient\widgets\GooglePlusButton
  • https://developers.google.com/ /web/signin

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

Свойство Тип Описание Определено в
$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 строка ID клиента 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\clients\GoogleHybrid
$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\clients\GoogleHybrid
defaultTitle() Генерирует заголовок сервиса. yii\authclient\clients\Google
defaultViewOptions() Возвращает значение по умолчанию для $viewOptions. yii\authclient\clients\GoogleHybrid
generateAuthState() Генерирует значение auth state. 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

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

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

Использовать и проверять параметр auth 'state' в процессе аутентификации. Если включено, то непрозрачное значение будет сгенерировано и применено к URL авторизации, чтобы сохранить состояние между запросом и обратным вызовом. Сервер авторизации включает это значение, когда перенаправляет пользовательский агент обратно клиенту. Этот параметр используется для предотвращения поддельных межсайтовых запросов.

public boolean $validateAuthState = false

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

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

Компонует значение по умолчанию для $returnUrl.

защищенный string defaultReturnUrl ( )
return string

URL возврата.

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

Возвращает значение по умолчанию для $viewOptions.

Конкретный клиент может переопределить этот метод, чтобы предоставить специфичные значения по умолчанию для параметров отображения.

защищенный array defaultViewOptions ( )
return array

Список значений по умолчанию для $viewOptions.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API