MoveElementEvent ​
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\MoveElementEvent » craft\events\ElementEvent » craft\events\CancelableEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0.0
Move element event class.
Public Properties ​
| Property | Description |
|---|---|
| action | string – The type of structure action being performed (one of craft\services\Structures::ACTION_PREPEND, ACTION_APPEND, ACTION_PLACE_BEFORE, or ACTION_PLACE_AFTER). |
| data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
| element | craft\base\ElementInterface – The element model associated with the event. |
| handled | boolean – Whether the event is handled. |
| isNew | boolean – Whether the element is brand new |
| isValid | boolean – Whether to continue performing the action that called this event |
| name | string – The event name. |
| sender | object, null – The sender of this event. |
| structureId | integer – The ID of the structure the element is being moved within. |
| targetElement | ?\craft\base\ElementInterface |
| targetElementId | integer, null – 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
- 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).
structureId ​
- Type
- integer
- Default value
null
The ID of the structure the element is being moved within.
targetElement ​
- Type
?\craft\base\ElementInterface- Default value
null
targetElementId ​
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.
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __construct() | |
| __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. |
| 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() | 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. |
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.