DefineEagerLoadingMapEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\DefineEagerLoadingMapEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.1

DefineEagerLoadingMapEvent class.

View source

Public Properties

PropertyDescription
criteriaarray, null – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
elementTypestring, null – The element type class to eager-load.
handlestring – The property handle used to identify which target elements should be included in the map
handledboolean – Whether the event is handled.
maparray, null – An array of element ID mappings, where each element is a sub-array with source and target keys.
namestring – The event name.
senderobject – The sender of this event.
sourceElementscraft\base\ElementInterface[] – An array of the source elements

criteria

Type
array, null

Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.

View source

elementType

Type
string, null

The element type class to eager-load.

View source

handle

Type
string

The property handle used to identify which target elements should be included in the map

View source

map

Type
array, null

An array of element ID mappings, where each element is a sub-array with source and target keys.

View source

sourceElements

Type
craft\base\ElementInterface[]

An array of the source elements

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.