Класс yii\authclient\SessionStateStorage
| Наследование | yii\authclient\SessionStateStorage » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\authclient\StateStorageInterface, yii\base\Configurable |
| Доступна с версии | 2.1 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/SessionStateStorage.php |
SessionStateStorage предоставляет хранилище состояния для клиента авторизации на основе веб-сессии.
См. также:
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений | yii\base\Component |
| $session | yii\web\Session|array|string | Объект сессии или идентификатор компонента приложения объекта сессии, который будет использоваться. | yii\authclient\SessionStateStorage |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в значение null. | yii\base\Component |
| attachBehavior() | Присоединяет поведение к компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, которые должен иметь этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Component |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| get() | Возвращает значение переменной состояния с именем переменной. | yii\authclient\SessionStateStorage |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все присоединенные к этому компоненту поведения. | yii\base\Component |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединенный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\authclient\SessionStateStorage |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| remove() | Удаляет переменную состояния. | yii\authclient\SessionStateStorage |
| set() | Добавляет переменную состояния. | yii\authclient\SessionStateStorage |
| trigger() | Вызывает событие. | yii\base\Component |
Подробности свойств
$session общедоступное свойство
Объект сессии или идентификатор компонента приложения для объекта сессии, который следует использовать.
После создания объекта SessionStateStorage, если вы хотите изменить это свойство, вы должны назначить ему только объект сессии.
Если не задано — будет использован компонент приложения 'session', но только если он доступен (например, в веб-приложении), в противном случае сессия не будет использоваться, и сохранение данных не будет производиться.
public yii\web\Session|array|string $session = null
Подробности методов
get() общедоступный метод
Возвращает значение переменной состояния по имени переменной.
Если переменная не существует, будет возвращено $defaultValue.
| public mixed get ( $key ) | ||
|---|---|---|
| $key | string |
Имя переменной |
| return | mixed |
Значение переменной или |
init() общедоступный метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) |
|---|
remove() общедоступный метод
Удаляет переменную состояния.
| public boolean remove ( $key ) | ||
|---|---|---|
| $key | string |
Имя переменной для удаления |
| return | boolean |
Успех. |
set() общедоступный метод
Добавляет переменную состояния.
Если имя уже существует, старое значение будет перезаписано.
| public 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-sessionstatestorage.html
