ExecuteGqlQueryEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\ExecuteGqlQueryEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.3.11

ExecuteGqlQueryEvent event class.

View source

# Public Properties

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

# accessToken

DEPRECATED

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

Type
string

The access token used for this request.

View source

# context

Type
mixed, null

The context that is shared between all resolvers.

View source

# operationName

Type
string, null

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

View source

# query

Type
string

The GraphQL query being executed

View source

# result

Type
array, null

The query result to be returned.

View source

# rootValue

Type
mixed, null

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

View source

# schemaId

Type
integer
Since
3.4.0

The id of the schema used for this request.

View source

# variables

Type
array, null

The variables used for this query.

View source

# Public Methods

Method Description
__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.