PHP Класс yii\authclient\Collection

Example application configuration: php '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', ], ], ] ... ]
С версии: 2.0
Автор: Paul Klimov ([email protected])
Наследование: extends yii\base\Component
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$httpClient HTTP client instance or configuration for the [[clients]]. If set, this value will be passed as 'httpClient' config option while instantiating particular client object. This option is useful for adjusting HTTP client configuration for the entire list of auth clients.

Открытые методы

Метод Описание
getClient ( string $id ) : yii\authclient\ClientInterface
getClients ( ) : yii\authclient\ClientInterface[]
hasClient ( string $id ) : boolean Checks if client exists in the hub.
setClients ( array $clients )

Защищенные методы

Метод Описание
createClient ( string $id, array $config ) : yii\authclient\ClientInterface Creates auth client instance from its array configuration.

Описание методов

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

Creates auth client instance from its array configuration.
protected createClient ( string $id, array $config ) : yii\authclient\ClientInterface
$id string auth client id.
$config array auth client instance configuration.
Результат yii\authclient\ClientInterface auth client instance.

getClient() публичный метод

public getClient ( string $id ) : yii\authclient\ClientInterface
$id string service id.
Результат yii\authclient\ClientInterface auth client instance.

getClients() публичный метод

public getClients ( ) : yii\authclient\ClientInterface[]
Результат yii\authclient\ClientInterface[] list of auth clients.

hasClient() публичный метод

Checks if client exists in the hub.
public hasClient ( string $id ) : boolean
$id string client id.
Результат boolean whether client exist.

setClients() публичный метод

public setClients ( array $clients )
$clients array list of auth clients

Описание свойств

$httpClient публичное свойство

HTTP client instance or configuration for the [[clients]]. If set, this value will be passed as 'httpClient' config option while instantiating particular client object. This option is useful for adjusting HTTP client configuration for the entire list of auth clients.
public $httpClient