Class yii\authclient\Collection

All Classes | Properties | Methods

Inheritance	yii\authclient\Collection » yii\base\Component » yii\base\Object
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\GoogleOpenId'
            ],
            '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	yii\base\Component
$clients	array	List of auth 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\Object
__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\Object
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\Object
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

yii\authclient\ClientInterface[] getClients( )
void setClients( array $clients )

List of auth clients

Method Details

createClient() protected method

Creates auth client instance from its array configuration.

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

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

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

hasClient() public method

Checks if client exists in the hub.

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

setClients() public method

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