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

PropertyDescription
accessTokenstring – The access token used for this request.
contextmixed, null – The context that is shared between all resolvers.
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
namestring – The event name.
operationNamestring, null – The name of the operation to use if requestString contains multiple possible operations.
querystring – The GraphQL query being executed
resultarray, null – The query result to be returned.
rootValuemixed, null – The root value to use when resolving the top-level object fields.
senderobject – The sender of this event.
variablesarray – The variables used for this query.

accessToken

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

variables

Type
array

The variables used for this query.

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.