MoveElementEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\MoveElementEvent » craft\events\ElementEvent » craft\events\CancelableEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.0.0

Move element event class.

View source (opens new window)

# Public Properties

Property Description
action string (opens new window) – The type of structure action being performed (one of craft\services\Structures::ACTION_PREPEND, ACTION_APPEND, ACTION_PLACE_BEFORE, or ACTION_PLACE_AFTER).
data (opens new window) mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler.
element craft\base\ElementInterface – The element model associated with the event.
handled (opens new window) boolean (opens new window) – Whether the event is handled.
isNew boolean (opens new window) – Whether the element is brand new
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), null (opens new window) – The sender of this event.
structureId integer (opens new window) – The ID of the structure the element is being moved within.
targetElement ?\craft\base\ElementInterface
targetElementId integer (opens new window), null (opens new window) – The ID of the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.

# action

Type
string (opens new window)
Default value
null
Since
4.5.0

The type of structure action being performed (one of craft\services\Structures::ACTION_PREPEND, ACTION_APPEND, ACTION_PLACE_BEFORE, or ACTION_PLACE_AFTER).

View source (opens new window)

# structureId

Type
integer (opens new window)
Default value
null

The ID of the structure the element is being moved within.

View source (opens new window)

# targetElement

Type
?\craft\base\ElementInterface
Default value
null

View source (opens new window)

# targetElementId

Type
integer (opens new window), null (opens new window)
Default value
null
Since
4.5.0

The ID of the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.

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.
getTargetElement() Returns the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.
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.

# getTargetElement()

Since
4.5.0

Returns the element that element is being moved in reference to, or null if element is being appended/prepended to the root of the structure.

View source (opens new window)

Returns

craft\base\ElementInterface, null (opens new window)