Class yii\authclient\SessionStateStorage
| Inheritance | yii\authclient\SessionStateStorage » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\authclient\StateStorageInterface, yii\base\Configurable |
| Available since version | 2.1 |
| Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/SessionStateStorage.php |
SessionStateStorage provides Auth client state storage based on web session.
See also:
Public 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 |
| $session | yii\web\Session|array|string | Session object or the application component ID of the session object to be used. | yii\authclient\SessionStateStorage |
Public 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\SessionStateStorage |
| 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\SessionStateStorage |
| 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\SessionStateStorage |
| set() | Adds a state variable. | yii\authclient\SessionStateStorage |
| trigger() | Triggers an event. | yii\base\Component |
Property Details
Session object or the application component ID of the session object to be used.
After the SessionStateStorage object is created, if you want to change this property, you should only assign it with a session object.
If not set - application 'session' component will be used, but only, if it is available (e.g. in web application), otherwise - no session will be used and no data saving will be performed.
Method Details
Returns the state variable value with the variable name.
| public mixed get ( $key ) | ||
| $key | string | The variable name |
| return | mixed | The variable value, or |
|---|---|---|
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 ( ) |
Removes a state variable.
| public boolean remove ( $key ) | ||
| $key | string | The name of the variable to be removed |
| return | boolean | Success. |
|---|---|---|
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 |