RegisterGqlEagerLoadableFields

Type
Class
Namespace
craft\events
Inherits
craft\events\RegisterGqlEagerLoadableFields » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.5.0

RegisterGqlEagerLoadableFields class.

View source (opens new window)

# Public Properties

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

# fieldList

Type
array (opens new window)
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 (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.