ExecuteGqlQueryEvent

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

ExecuteGqlQueryEvent event class.

View source (opens new window)

# Public Properties

Property Description
accessToken string (opens new window) – The access token used for this request.
context mixed, null (opens new window) – The context that is shared between all resolvers.
data (opens new window) mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler.
handled (opens new window) boolean (opens new window) – Whether the event is handled.
name (opens new window) string (opens new window) – The event name.
operationName string (opens new window), null (opens new window) – The name of the operation to use if requestString contains multiple possible operations.
query string (opens new window) – The GraphQL query being executed
result array (opens new window), null (opens new window) – The query result to be returned.
rootValue mixed, null (opens new window) – The root value to use when resolving the top-level object fields.
schemaId integer (opens new window) – The id of the schema used for this request.
sender (opens new window) object (opens new window) – The sender of this event.
variables array (opens new window), null (opens new window) – The variables used for this query.

# accessToken

DEPRECATED

Deprecated in 3.4.0. Use schemaId instead to determine schema used.

Type
string (opens new window)
Default value
null

The access token used for this request.

View source (opens new window)

# context

Type
mixed, null (opens new window)
Default value
null

The context that is shared between all resolvers.

View source (opens new window)

# operationName

Type
string (opens new window), null (opens new window)
Default value
null

The name of the operation to use if requestString contains multiple possible operations.

View source (opens new window)

# query

Type
string (opens new window)
Default value
null

The GraphQL query being executed

View source (opens new window)

# result

Type
array (opens new window), null (opens new window)
Default value
null

The query result to be returned.

View source (opens new window)

# rootValue

Type
mixed, null (opens new window)
Default value
null

The root value to use when resolving the top-level object fields.

View source (opens new window)

# schemaId

Type
integer (opens new window)
Default value
null
Since
3.4.0

The id of the schema used for this request.

View source (opens new window)

# variables

Type
array (opens new window), null (opens new window)
Default value
null

The variables used for this query.

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.