Gql

Type
Class
Namespace
craft\services
Inherits
craft\services\Gql » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.3.0

The Gql service provides GraphQL functionality.

View source

Public Properties

activeSchema

Type
craft\models\GqlSchema
Access
Read-only

View source

allPermissions

Type
array
Access
Read-only

View source

publicSchema

Type
craft\models\GqlSchema
Access
Read-only

View source

schemaDef

Type
\GraphQL\Type\Schema
Access
Read-only

View source

schemas

Type
craft\models\GqlSchema[]
Access
Read-only

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__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.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
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.
deleteSchemaById()Deletes a GraphQL schema by its ID.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
executeQuery()Execute a GraphQL query for a given active schema.
flushCaches()Flush all GraphQL caches, registries and loaders.
getActiveSchema()Returns the active GraphQL schema.
getAllPermissions()Returns all of the known GraphQL permissions, sorted by category.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCachedResult()Get the cached result for a key.
getPublicSchema()Returns the public schema. If it does not exist, it will be created.
getSchemaByAccessToken()Returns a GraphQL schema by its access token.
getSchemaById()Returns a GraphQL schema by its id.
getSchemaByUid()Returns a GraphQL schema by its UID.
getSchemaDef()Returns the GraphQL schema.
getSchemas()Returns all GraphQL schemas.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named 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.
invalidateCaches()Invalidate all GraphQL result caches.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
saveSchema()Saves a GraphQL schema.
setActiveSchema()Sets the active GraphQL schema.
setCachedResult()Cache a result for the key and tag it.
trigger()Triggers an event.

deleteSchemaById()

Deletes a GraphQL schema by its ID.

View source

Arguments

  • $id (integer) – The transform's ID

Returns

boolean – Whether the token was deleted.

executeQuery()

Since
3.3.11

Execute a GraphQL query for a given active schema.

View source

Arguments

Returns

array

flushCaches()

Flush all GraphQL caches, registries and loaders.

View source

Returns

void

getActiveSchema()

Returns the active GraphQL schema.

View source

Returns

craft\models\GqlSchema

Throws

getAllPermissions()

Returns all of the known GraphQL permissions, sorted by category.

View source

Returns

array

getCachedResult()

Since
3.3.12

Get the cached result for a key.

View source

Arguments

  • $cacheKey

Returns

mixed

getPublicSchema()

Returns the public schema. If it does not exist, it will be created.

View source

Returns

craft\models\GqlSchema

Throws

getSchemaByAccessToken()

Returns a GraphQL schema by its access token.

View source

Arguments

Returns

craft\models\GqlSchema

Throws

getSchemaById()

Returns a GraphQL schema by its id.

View source

Arguments

Returns

craft\models\GqlSchema, null

getSchemaByUid()

Returns a GraphQL schema by its UID.

View source

Arguments

Returns

craft\models\GqlSchema

Throws

getSchemaDef()

Returns the GraphQL schema.

View source

Arguments

Returns

\GraphQL\Type\Schema

Throws

getSchemas()

Returns all GraphQL schemas.

View source

Returns

craft\models\GqlSchema[]

invalidateCaches()

Since
3.3.12

Invalidate all GraphQL result caches.

View source

saveSchema()

Saves a GraphQL schema.

View source

Arguments

  • $schema (craft\models\GqlSchema) – The schema to save
  • $runValidation (boolean) – Whether the schema should be validated
  • $invalidateCaches (boolean) – Whether the cached results should be invalidated

Returns

boolean – Whether the schema was saved successfully

Throws

setActiveSchema()

Sets the active GraphQL schema.

View source

Arguments

Throws

setCachedResult()

Since
3.3.12

Cache a result for the key and tag it.

View source

Arguments

  • $cacheKey
  • $result

Constants

ConstantDescription
CACHE_TAG

Events

EVENT_AFTER_EXECUTE_GQL_QUERY

Type
craft\events\ExecuteGqlQueryEvent
Since
3.3.11

The event that is triggered after executing the GraphQL query.

Plugins get a chance to do sometheing after a performed GraphQL query.

Example

EVENT_BEFORE_EXECUTE_GQL_QUERY

Type
craft\events\ExecuteGqlQueryEvent
Since
3.3.11

The event that is triggered before executing the GraphQL query.

Plugins get a chance to modify the query or return a cached response.

Example

EVENT_REGISTER_GQL_DIRECTIVES

Type
craft\events\RegisterGqlDirectivesEvent

The event that is triggered when registering GraphQL directives.

Plugins get a chance to add their own GraphQL directives. See GraphQL for documentation on adding GraphQL support.

Example

EVENT_REGISTER_GQL_QUERIES

Type
craft\events\RegisterGqlQueriesEvent

The event that is triggered when registering GraphQL queries.

Plugins get a chance to add their own GraphQL queries. See GraphQL for documentation on adding GraphQL support.

Example

EVENT_REGISTER_GQL_TYPES

Type
craft\events\RegisterGqlTypesEvent

The event that is triggered when registering GraphQL types.

Plugins get a chance to add their own GraphQL types. See GraphQL for documentation on adding GraphQL support.

Example