Класс yii\authclient\Collection
| Наследование | yii\authclient\Collection » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/Collection.php |
Collection — хранилище всех клиентов авторизации в приложении.
Пример конфигурации приложения:
'components' => [
'authClientCollection' => [
'class' => 'yii\authclient\Collection',
'clients' => [
'google' => [
'class' => 'yii\authclient\clients\Google',
'clientId' => 'google_client_id',
'clientSecret' => 'google_client_secret',
],
'facebook' => [
'class' => 'yii\authclient\clients\Facebook',
'clientId' => 'facebook_client_id',
'clientSecret' => 'facebook_client_secret',
],
],
]
...
]
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений | yii\base\Component |
| $clients | массив | Список клиентов авторизации | yii\authclient\Collection |
| $httpClient | yii\httpclient\Client|массив|строка | Экземпляр HTTP-клиента или конфигурация для $clients. | yii\authclient\Collection |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, которые должен демонстрировать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getClient() | yii\authclient\Collection | |
| getClients() | yii\authclient\Collection | |
| hasClient() | Проверяет, существует ли клиент в узле. | yii\authclient\Collection |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к событию с заданным именем. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| setClients() | yii\authclient\Collection | |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| createClient() | Создаёт экземпляр клиента авторизации из его конфигурации в формате массива. | yii\authclient\Collection |
Подробное описание свойств
$clients публичное свойство
Список клиентов авторизации
public yii\authclient\ClientInterface[] getClients ( )
public void setClients ( array $clients )
$httpClient публичное свойство
Экземпляр HTTP-клиента или конфигурация для $clients. Если задано, это значение будет передано как опция конфигурации 'httpClient' при создании конкретного объекта клиента. Эта опция полезна для настройки конфигурации HTTP-клиента для всего списка клиентов авторизации.
public yii\httpclient\Client|array|string $httpClient = null
Подробное описание методов
createClient() защищённый метод
Создаёт экземпляр клиента авторизации из его конфигурации массива.
| защищённый yii\authclient\ClientInterface createClient ( $id, $config ) | ||
|---|---|---|
| $id | строка |
Идентификатор клиента авторизации. |
| $config | массив |
Конфигурация экземпляра клиента авторизации. |
| return | yii\authclient\ClientInterface |
Экземпляр клиента авторизации. |
getClient() публичный метод
| публичный yii\authclient\ClientInterface getClient ( $id ) | ||
|---|---|---|
| $id | строка |
Идентификатор сервиса. |
| return | yii\authclient\ClientInterface |
Экземпляр клиента авторизации. |
| throws | yii\base\InvalidParamException |
при запросе несуществующего клиента. |
getClients() публичный метод
| публичный yii\authclient\ClientInterface[] getClients ( ) | ||
|---|---|---|
| return | yii\authclient\ClientInterface[] |
Список клиентов авторизации. |
hasClient() публичный метод
Проверяет наличие клиента в хранилище.
| публичный boolean hasClient ( $id ) | ||
|---|---|---|
| $id | строка |
Идентификатор клиента. |
| return | boolean |
Признак существования клиента. |
setClients() публичный метод
| публичный void setClients ( массив $clients ) | ||
|---|---|---|
| $clients | массив |
Список клиентов авторизации |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-collection.html
