CancelableEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\CancelableEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Extended by
craft\events\AssetEvent, craft\events\AssetTransformImageEvent, craft\events\DeleteSiteEvent, craft\events\ElementActionEvent, craft\events\GenerateTransformEvent, craft\events\ReplaceAssetEvent, craft\events\SiteEvent, craft\events\TemplateEvent, craft\events\UserAssignGroupEvent, craft\events\UserEvent, craft\events\UserGroupsAssignEvent
Since
3.0.0

CancelableEvent class.

View source (opens new window)

# Public Properties

Property Description
data (opens new window) mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler.
handled (opens new window) boolean (opens new window) – Whether the event is handled.
isValid boolean (opens new window) – Whether to continue performing the action that called this event
name (opens new window) string (opens new window) – The event name.
sender (opens new window) object (opens new window) – The sender of this event.

# isValid

Type
boolean (opens new window)
Default value
true

Whether to continue performing the action that called this event

View source (opens new window)

# Public Methods

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