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