Class craft\events\WidgetEvent
- Inheritance
- craft\events\WidgetEvent » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/events/WidgetEvent.php
WidgetEvent class.
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 |
$isNew |
boolean | Whether the widget is brand new | craft\events\WidgetEvent |
$name |
string | The event name. | yii\base\Event |
$sender |
object | The sender of this event. | yii\base\Event |
$widget |
craft\base\WidgetInterface, null | The widget associated with this event. | craft\events\WidgetEvent |
Method | Description | Defined 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
$isNew
public property
#
Whether the widget is brand new
public boolean $isNew = false
$widget
public property
#
The widget associated with this event.
public craft\base\WidgetInterface, null $widget = null