RegisterGqlEagerLoadableFields

Type

Class

Namespace

craft\events

Inherits

craft\events\RegisterGqlEagerLoadableFields » craft\base\Event » yii\base\Event » yii\base\BaseObject

Implements

yii\base\Configurable

Since

3.5.0

RegisterGqlEagerLoadableFields class.

View source

Public Properties

Property	Description
data	mixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
fieldList	array – List of additional eager-loadable fields to be used as reference, when parsing the GraphQL query and building the eager-load condition array.
handled	boolean – Whether the event is handled.
name	string – The event name.
sender	object, null – The sender of this event.

fieldList

Type

array

Default value

[]

List of additional eager-loadable fields to be used as reference, when parsing the GraphQL query and building the eager-load condition array.

The field list is an array, where the key is the field name to be allowed. The value is a list of allowed occurrences for the node in the form of an array. Occurrence is a class name of a relational field that the containing field must be an instance of. For example, the "uploader" field can be eager-loaded only for Asset fields, so the occurrence will be craft\fields\Assets.

If a field is encountered in a GraphQL query outside of a relational field scope, it is always allowed.

There are two special values you can use:

• '*' can be used both as a key or value and is used to configure the field to be allowed anywhere.
• 'canBeAliased' is used to configure whether the GraphQL field alias (if any) can be used when constructing the eager-loading parameters. Defaults to true. To invert the behavior, use canBeAliased as a key and set the value to the required boolean value.

View source

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.