Класс yii\base\ActionEvent
| Наследование | yii\base\ActionEvent » yii\base\Event » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/base/ActionEvent.php |
ActionEvent представляет параметр события, используемый для события действия.
Установив свойство $isValid, можно управлять тем, будет ли продолжаться выполнение действия.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $action | yii\base\Action | Действие, выполняемое в данный момент | yii\base\ActionEvent |
| $data | смешанный | Данные, передаваемые в yii\base\Component::on() при добавлении обработчика событий. | yii\base\Event |
| $handled | boolean | Обработано ли событие. | yii\base\Event |
| $isValid | boolean | Продолжать ли выполнение действия. | yii\base\ActionEvent |
| $name | string | Имя события. | yii\base\Event |
| $result | смешанный | Результат действия. | yii\base\ActionEvent |
| $sender | объект | Отправитель этого события. | yii\base\Event |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\ActionEvent |
| __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 |
Подробное описание свойств
$action открытое свойство
Действие, выполняемое в данный момент
public yii\base\Action $action = null
$isValid открытое свойство
Продолжать ли выполнение действия. Обработчики событий yii\base\Controller::EVENT_BEFORE_ACTION могут установить это свойство, чтобы принять решение о продолжении выполнения текущего действия.
public boolean $isValid = true
$result открытое свойство
Результат действия. Обработчики событий могут изменить это свойство, чтобы изменить результат действия.
public mixed $result = null
Подробное описание методов
__construct() открытый метод
Конструктор.
| public void __construct ( $action, $config = [] ) | ||
|---|---|---|
| $action | yii\base\Action |
Действие, связанное с этим событием действия. |
| $config | массив |
Пара имя-значение, которые будут использоваться для инициализации свойств объекта |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-actionevent.html
