Интерфейс yii\authclient\StateStorageInterface
| Реализуется | yii\authclient\SessionStateStorage |
|---|---|
| Доступна с версии | 2.1 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/StateStorageInterface.php |
StateStorageInterface — это интерфейс для хранения состояния клиента авторизации.
Здесь под «состоянием» подразумевается именованная переменная, сохраняемая между различными запросами.
Примечание: для корректной работы хранилище состояния должно меняться в зависимости от сеанса приложения, например, разные пользователи веб-приложения не должны совместно использовать состояние с одинаковым именем.
Общедоступные методы
| Метод | Описание | Определено |
|---|---|---|
| get() | Возвращает значение переменной состояния с указанным именем. | yii\authclient\StateStorageInterface |
| remove() | Удаляет переменную состояния. | yii\authclient\StateStorageInterface |
| set() | Добавляет переменную состояния. | yii\authclient\StateStorageInterface |
Подробное описание методов
get() public abstract method
Возвращает значение переменной состояния с указанным именем.
Если переменная не существует, возвращается $defaultValue.
| public abstract mixed get ( $key ) | ||
|---|---|---|
| $key | string |
Имя переменной |
| return | mixed |
Значение переменной или |
remove() public abstract method
Удаляет переменную состояния.
| public abstract boolean remove ( $key ) | ||
|---|---|---|
| $key | string |
Имя переменной для удаления |
| return | boolean |
Успешно или нет. |
set() public abstract method
Добавляет переменную состояния.
Если переменная с указанным именем уже существует, старое значение будет перезаписано.
| public abstract void set ( $key, $value ) | ||
|---|---|---|
| $key | string |
Имя переменной |
| $value | mixed |
Значение переменной |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-statestorageinterface.html
