Class yii\base\WidgetEvent

继承yii\base\WidgetEvent » yii\base\Event » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0.11
源代码 https://github.com/yiisoft/yii2/blob/master/framework/base/WidgetEvent.php

WidgetEvent 表示用于小部件事件的事件参数.

通过设置 $isValid 属性, 可以控制是否继续运行小部件.

公共属性

隐藏继承的属性

属性类型描述定义在
$data mixed 附加事件处理程序时传递给 yii\base\Component::on() 的数据. yii\base\Event
$handled boolean 事件是否被处理. yii\base\Event
$isValid boolean 是否继续运行小部件. yii\base\WidgetEvent
$name string 事件的名称. yii\base\Event
$result mixed 小部件的结果. yii\base\WidgetEvent
$sender object 此事件的发送者. yii\base\Event

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__construct() 构造函数. yii\base\BaseObject
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
hasHandlers() 返回一个值, 指示是否有附加到指定类级别事件的处理程序. yii\base\Event
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
off() 从类级别的事件中分离事件处理程序. yii\base\Event
offAll() 分离所有已注册的类级别事件处理程序. yii\base\Event
on() 将事件处理程序附加到类级别的事件. yii\base\Event
trigger() 触发类级别的事件. yii\base\Event

属性详情

$isValid public 属性

是否继续运行小部件. yii\base\Widget::EVENT_BEFORE_RUN 的事件处理程序可以设置此属性, 以决定是否继续运行当前的小部件.

public boolean $isValid true
$result public 属性

小部件的结果. 事件处理程序可以修改此属性以更改小部件结果.

public mixed $result null