0 follower

Class yii\base\WidgetEvent

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

WidgetEvent represents the event parameter used for a widget event.

By setting the $isValid property, one may control whether to continue running the widget.

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 running the widget. yii\base\WidgetEvent
$name string The event name. yii\base\Event
$result mixed The widget result. yii\base\WidgetEvent
$sender object The sender of this event. yii\base\Event

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
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\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
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 running the widget. Event handlers of yii\base\Widget::EVENT_BEFORE_RUN may set this property to decide whether to continue running the current widget.

public boolean $isValid true
$result public property

The widget result. Event handlers may modify this property to change the widget result.

public mixed $result null