Class yii\base\ViewEvent

Inheritanceyii\base\ViewEvent » yii\base\Event » yii\base\Object
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/base/ViewEvent.php

ViewEvent represents events triggered by the yii\base\View component.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$data mixed The data that is passed to yii\base\Component::on() when attaching an event handler. yii\base\Event
$handled boolean Whether the event is handled. yii\base\Event
$isValid boolean Whether to continue rendering the view file. yii\base\ViewEvent
$name string The event name. yii\base\Event
$output string The rendering result of yii\base\View::renderFile(). yii\base\ViewEvent
$params array The parameter array passed to the yii\base\View::render() method. yii\base\ViewEvent
$sender object The sender of this event. yii\base\Event
$viewFile string The view file being rendered. yii\base\ViewEvent

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__construct() Constructor. yii\base\Object
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
className() Returns the fully qualified name of this class. yii\base\Object
hasHandlers() Returns a value indicating whether there is any handler attached to the specified class-level event. yii\base\Event
hasMethod() Returns a value indicating whether a method is defined. yii\base\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
init() Initializes the object. yii\base\Object
off() Detaches an event handler from a class-level event. yii\base\Event
offAll() Detaches all registered class-level event handlers. yii\base\Event
on() Attaches an event handler to a class-level event. yii\base\Event
trigger() Triggers a class-level event. yii\base\Event

Property Details

$isValid public property

Whether to continue rendering the view file. Event handlers of yii\base\View::EVENT_BEFORE_RENDER may set this property to decide whether to continue rendering the current view file.

public boolean $isValid true
$output public property

The rendering result of yii\base\View::renderFile(). Event handlers may modify this property and the modified output will be returned by yii\base\View::renderFile(). This property is only used by yii\base\View::EVENT_AFTER_RENDER event.

public string $output null
$params public property

The parameter array passed to the yii\base\View::render() method.

public array $params null
$viewFile public property

The view file being rendered.

public string $viewFile null