DefineEagerLoadingMapEvent ​
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\DefineEagerLoadingMapEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.1.0
DefineEagerLoadingMapEvent class.
Public Properties ​
| Property | Description |
|---|---|
| criteria | array, null – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements. |
| data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
| elementType | class-string<\craft\base\ElementInterface>, null – The element type class to eager-load. |
| handle | string – The property handle used to identify which target elements should be included in the map |
| handled | boolean – Whether the event is handled. |
| map | array, null – An array of element ID mappings, where each element is a sub-array with source and target keys. |
| name | string – The event name. |
| sender | object, null – The sender of this event. |
| sourceElements | craft\base\ElementInterface[] – An array of the source elements |
criteria ​
Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.
elementType ​
- Type
class-string<\craft\base\ElementInterface>, null- Default value
null
The element type class to eager-load.
handle ​
- Type
- string
- Default value
null
The property handle used to identify which target elements should be included in the map
map ​
An array of element ID mappings, where each element is a sub-array with source and target keys.
sourceElements ​
- Type
- craft\base\ElementInterface[]
- Default value
null
An array of the source elements
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. |
| 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. |