Skip to content

Event

Type
Class
Namespace
craft\base
Inherits
craft\base\Event » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Extended by
craft\events\AssetBundleEvent, craft\events\BulkElementsEvent, craft\events\DefineEditUserScreensEvent, craft\events\DuplicateNestedElementsEvent
Since
4.4.0

ElementTrait implements the common methods and properties for element classes.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
namestring – The event name.
senderobject, null – The sender of this event.

Public Methods

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

once()

Attaches an event handler to a class-level event, which will be triggered at most one time.

See also on()View source

Arguments

  • $class (string) – The fully qualified class name to which the event handler needs to attach.
  • $name (string) – The event name.
  • $handler (callable) – The event handler.
  • $data (mixed) – The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.
  • $append (boolean) – Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.