Класс yii\web\UserEvent
| Наследование | yii\web\UserEvent » yii\base\Event » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/UserEvent.php |
Этот класс событий используется для событий, срабатываемых классом yii\web\User.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $cookieBased | boolean | Является ли вход cookie-базированным. | yii\web\UserEvent |
| $data | смешанный | Данные, передаваемые в yii\base\Component::on() при подключении обработчика событий. | yii\base\Event |
| $duration | integer | Количество секунд, в течение которых пользователь может оставаться в состоянии входа в систему. | yii\web\UserEvent |
| $handled | boolean | Обработан ли событие. | yii\base\Event |
| $identity | yii\web\IdentityInterface | Объект идентификатора, связанный с этим событием | yii\web\UserEvent |
| $isValid | boolean | Должен ли продолжаться вход или выход. | yii\web\UserEvent |
| $name | string | Имя события. | yii\base\Event |
| $sender | object | Отправитель этого события. | yii\base\Event |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с заданным именем, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| hasHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию на уровне класса. | yii\base\Event |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет обработчик событий от события на уровне класса. | yii\base\Event |
| offAll() | Отсоединяет все зарегистрированные обработчики событий на уровне класса. | yii\base\Event |
| on() | Присоединяет обработчик событий к событию на уровне класса. | yii\base\Event |
| trigger() | Вызывает событие на уровне класса. | yii\base\Event |
Подробное описание свойств
$cookieBased публичное свойство
Является ли вход cookie-базированным. Это свойство имеет смысл только для событий yii\web\User::EVENT_BEFORE_LOGIN и yii\web\User::EVENT_AFTER_LOGIN.
public boolean $cookieBased = null
$duration публичное свойство
Количество секунд, в течение которых пользователь может оставаться в состоянии входа в систему. Если 0, это означает вход в систему до тех пор, пока пользователь не закроет браузер или сессия не будет вручную уничтожена.
public integer $duration = null
$identity публичное свойство
Объект идентификатора, связанный с этим событием
public yii\web\IdentityInterface $identity = null
$isValid публичное свойство
Должен ли продолжаться вход или выход. Обработчики событий могут изменить это свойство, чтобы определить, следует ли продолжить вход или выход. Это свойство имеет смысл только для событий yii\web\User::EVENT_BEFORE_LOGIN и yii\web\User::EVENT_BEFORE_LOGOUT.
public boolean $isValid = true
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-userevent.html
