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