Class yii\authclient\Collection

All Classes | Methods

Inheritance	yii\authclient\Collection » yii\base\Component
Available since version	2.0

Collection is a storage for all auth clients in the application.

Example application configuration:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'google' => [
                'class' => 'yii\authclient\clients\GoogleOpenId'
            ],
            'facebook' => [
                'class' => 'yii\authclient\clients\Facebook',
                'clientId' => 'facebook_client_id',
                'clientSecret' => 'facebook_client_secret',
            ],
        ],
    ]
    ...
]

Public Methods

Hide inherited methods

Method	Description	Defined By
getClient()		yii\authclient\Collection
getClients()		yii\authclient\Collection
hasClient()	Checks if client exists in the hub.	yii\authclient\Collection
setClients()		yii\authclient\Collection

Protected Methods

Hide inherited methods

Method	Description	Defined By
createClient()	Creates auth client instance from its array configuration.	yii\authclient\Collection

Method Details

createClient() protected method

Creates auth client instance from its array configuration.

protected yii\authclient\ClientInterface createClient ( $id, $config )
$id	string	Auth client id.
$config	array	Auth client instance configuration.
return	yii\authclient\ClientInterface	Auth client instance.

getClient() public method

public yii\authclient\ClientInterface getClient ( $id )
$id	string	Service id.
return	yii\authclient\ClientInterface	Auth client instance.
throws	\yii\base\InvalidParamException	on non existing client request.

getClients() public method

public yii\authclient\ClientInterface[] getClients ( )
return	yii\authclient\ClientInterface[]	List of auth clients.

hasClient() public method

Checks if client exists in the hub.

public boolean hasClient ( $id )
$id	string	Client id.
return	boolean	Whether client exist.

setClients() public method

public void setClients ( array $clients )
$clients	array	List of auth clients