Class yii\authclient\CacheStateStorage

All Classes | Properties | Methods

Inheritance	yii\authclient\CacheStateStorage » yii\base\Component » yii\base\BaseObject
Implements	yii\authclient\StateStorageInterface, yii\base\Configurable
Source Code	https://github.com/yiisoft/yii2-authclient/blob/master/CacheStateStorage.php

CacheStateStorage provides Auth client state storage based in cache component.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$cache	yii\caching\Cache\|array\|string	Cache object or the application component ID of the cache object to be used.	yii\authclient\CacheStateStorage
$prefix			yii\authclient\CacheStateStorage

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
get()	Returns the state variable value with the variable name.	yii\authclient\CacheStateStorage
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
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\authclient\CacheStateStorage
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
remove()	Removes a state variable.	yii\authclient\CacheStateStorage
set()	Adds a state variable.	yii\authclient\CacheStateStorage
trigger()	Triggers an event.	yii\base\Component

Property Details

$cache public property

Cache object or the application component ID of the cache object to be used.

After the CacheStateStorage object is created, if you want to change this property, you should only assign it with a cache object.

If not set - application 'cache' component will be used, but only, if it is available (e.g. in web application), otherwise - no cache will be used and no data saving will be performed.

public yii\caching\Cache|array|string $cache = null

$prefix public property

public $prefix = 'cacheStorage'

Method Details

get() public method

Returns the state variable value with the variable name.

public mixed get ( $key )
$key	string	The variable name
return	mixed	The variable value, or `null` if the variable does not exist.

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

remove() public method

Removes a state variable.

public boolean remove ( $key )
$key	string	The name of the variable to be removed
return	boolean	Success.

set() public method

Adds a state variable.

If the specified name already exists, the old value will be overwritten.

public void set ( $key, $value )
$key	string	Variable name
$value	mixed	Variable value