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