W3cubDocs

/Yii 2.0

Class yii\base\WidgetEvent

Inheritance yii\base\WidgetEvent » yii\base\Event » yii\base\Object
Implements yii\base\Configurable
Available since version 2.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

Property Type Description Defined 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

Method Description Defined 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 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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-widgetevent.html