BatchElementActionEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\BatchElementActionEvent » craft\events\ElementQueryEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.2.0

Batch element action event class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
elementcraft\base\ElementInterface – The element being processed
exceptionThrowable, null – The exception that was thrown if any
handledboolean – Whether the event is handled.
namestring – The event name.
positioninteger – The element's position in the query (1-indexed)
querycraft\elements\db\ElementQueryInterface – The element query.
senderobject – The sender of this event.

element

Type
craft\base\ElementInterface

The element being processed

View source

exception

Type
Throwable, null

The exception that was thrown if any

View source

position

Type
integer

The element's position in the query (1-indexed)

View source

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.
trigger()Triggers a class-level event.