Class yii\authclient\Collection

All Classes | Properties | Methods

Inheritance	yii\authclient\Collection » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-authclient/blob/master/Collection.php

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\Google',
                'clientId' => 'google_client_id',
                'clientSecret' => 'google_client_secret',
             ],
            'facebook' => [
                'class' => 'yii\authclient\clients\Facebook',
                'clientId' => 'facebook_client_id',
                'clientSecret' => 'facebook_client_secret',
            ],
        ],
    ]
    ...
]

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component. This property is read-only.	yii\base\Component
$clients	yii\authclient\ClientInterface[]	List of auth clients. This property is read-only.	yii\authclient\Collection
$httpClient	yii\httpclient\Client\|array\|string	HTTP client instance or configuration for the $clients.	yii\authclient\Collection

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getClient()		yii\authclient\Collection
getClients()		yii\authclient\Collection
hasClient()	Checks if client exists in the hub.	yii\authclient\Collection
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\base\BaseObject
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
setClients()		yii\authclient\Collection
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

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

Property Details

$clients public property

List of auth clients. This property is read-only.

public yii\authclient\ClientInterface[] $clients = null

$httpClient public property

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 yii\httpclient\Client|array|string $httpClient = null

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