yii\authclient\StateStorageInterface - Yii2 类参考手册
Interface yii\authclient\StateStorageInterface
全部
| 方法 Methods
Implemented by | yii\authclient\SessionStateStorage |
---|---|
Available since version | 2.1 |
StateStorageInterface is an interface for Auth client state storage.
Herein 'state' means a named variable, which is persistent between different requests.
Note: in order to function correctly state storage should vary depending on application session, e.g. different web users should not share state with the same name.
Public Methods
隐藏继承的方法 Hide inherited methods
方法 Method | 简介 Description | 定义在 Defined By |
---|---|---|
get() | Returns the state variable value with the variable name. | yii\authclient\StateStorageInterface |
remove() | Removes a state variable. | yii\authclient\StateStorageInterface |
set() | Adds a state variable. | yii\authclient\StateStorageInterface |
方法详情 Method Details
Returns the state variable value with the variable name.
public abstract mixed get ( $key ) | ||
$key | string | The variable name |
return | mixed | The variable value, or |
---|
Removes a state variable.
public abstract 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 abstract void set ( $key, $value ) | ||
$key | string | Variable name |
$value | mixed | Variable value |