MergeElementsEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\MergeElementsEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

Merged elements event class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
mergedElementIdinteger, null – The ID of the element that just got merged into the other.
namestring – The event name.
prevailingElementIdinteger, null – The ID of the element that prevailed in the merge.
senderobject – The sender of this event.

mergedElementId

Type
integer, null

The ID of the element that just got merged into the other.

View source

prevailingElementId

Type
integer, null

The ID of the element that prevailed in the merge.

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.