Gql

Type

Class

Namespace

craft\helpers

Inherits

craft\helpers\Gql

Since

3.3.0

Class Gql

View source (opens new window)

Public Methods

Method	Description
applyDirectives()	Apply directives (if any) to a resolved value according to source and resolve info.
canMutateAssets()	Return true if active schema can mutate assets.
canMutateCategories()	Return true if active schema can mutate categories.
canMutateEntries()	Return true if active schema can mutate entries.
canMutateGlobalSets()	Return true if active schema can mutate global sets.
canMutateTags()	Return true if active schema can mutate tags.
canQueryAssets()	Return true if active schema can query assets.
canQueryCategories()	Return true if active schema can query categories.
canQueryEntries()	Return true if active schema can query entries.
canQueryGlobalSets()	Return true if active schema can query global sets.
canQueryTags()	Return true if active schema can query tags.
canQueryUsers()	Return true if active schema can query users.
canSchema()	Returns true if the active schema can perform the action on the scope.
createFullAccessSchema()	Creates a temporary schema with full access to the GraphQL API.
extractAllowedEntitiesFromSchema()	Extracts all the allowed entities from the active schema for the action.
extractEntityAllowedActions()	Return a list of all the actions the current schema is allowed for a given entity.
getFieldNameWithAlias()	Looking at the resolve information and the source queried, return the field name or it's alias, if used.
getUnionType()	Get (and create if needed) a union type by name, included types and a resolver funcion.
isSchemaAwareOf()	Returns true if the active schema is aware of the provided scope(s).
prepareTransformArguments()	Prepare arguments intended for Asset transforms.
wrapInNonNull()	Wrap a GQL object type in a NonNull type.

applyDirectives()

Apply directives (if any) to a resolved value according to source and resolve info.

View source (opens new window)

Arguments

• $source
• $resolveInfo (\GraphQL\Type\Definition\ResolveInfo)
• $value

Returns

mixed

canMutateAssets()

Since

3.5.0

Return true if active schema can mutate assets.

View source (opens new window)

Returns

boolean (opens new window)

canMutateCategories()

Since

3.5.0

Return true if active schema can mutate categories.

View source (opens new window)

Returns

boolean (opens new window)

canMutateEntries()

Since

3.5.0

Return true if active schema can mutate entries.

View source (opens new window)

Returns

boolean (opens new window)

canMutateGlobalSets()

Since

3.5.0

Return true if active schema can mutate global sets.

View source (opens new window)

Returns

boolean (opens new window)

canMutateTags()

Since

3.5.0

Return true if active schema can mutate tags.

View source (opens new window)

Returns

boolean (opens new window)

canQueryAssets()

Return true if active schema can query assets.

View source (opens new window)

Returns

boolean (opens new window)

canQueryCategories()

Return true if active schema can query categories.

View source (opens new window)

Returns

boolean (opens new window)

canQueryEntries()

Return true if active schema can query entries.

View source (opens new window)

Returns

boolean (opens new window)

canQueryGlobalSets()

Return true if active schema can query global sets.

View source (opens new window)

Returns

boolean (opens new window)

canQueryTags()

Return true if active schema can query tags.

View source (opens new window)

Returns

boolean (opens new window)

canQueryUsers()

Return true if active schema can query users.

View source (opens new window)

Returns

boolean (opens new window)

canSchema()

Returns true if the active schema can perform the action on the scope.

View source (opens new window)

Arguments

• $scope (string (opens new window)) – The scope to check.
• $action (string (opens new window)) – The action. Defaults to "read"

Returns

boolean (opens new window)

Throws

• craft\errors\GqlException

createFullAccessSchema()

Since

3.4.0

Creates a temporary schema with full access to the GraphQL API.

View source (opens new window)

Returns

craft\models\GqlSchema

extractAllowedEntitiesFromSchema()

Extracts all the allowed entities from the active schema for the action.

View source (opens new window)

Arguments

• $action (string (opens new window)) – The action for which the entities should be extracted. Defaults to "read"

Returns

array (opens new window)

extractEntityAllowedActions()

Return a list of all the actions the current schema is allowed for a given entity.

View source (opens new window)

Arguments

• $entity (string (opens new window))

Returns

array (opens new window)

getFieldNameWithAlias()

Looking at the resolve information and the source queried, return the field name or it's alias, if used.

View source (opens new window)

Arguments

• $resolveInfo (\GraphQL\Type\Definition\ResolveInfo)
• $source
• $context

Returns

string (opens new window)

getUnionType()

Get (and create if needed) a union type by name, included types and a resolver funcion.

View source (opens new window)

Arguments

• $typeName (string (opens new window)) – The union type name.
• $includedTypes (array (opens new window)) – The type the union should include
• $resolveFunction (callable (opens new window)) – The resolver function to use to resolve a specific type.

Returns

mixed

isSchemaAwareOf()

Returns true if the active schema is aware of the provided scope(s).

View source (opens new window)

Arguments

• $scopes (string (opens new window), string (opens new window)[]) – The scope(s) to check.

Returns

boolean (opens new window)

prepareTransformArguments()

Since

3.5.3

Prepare arguments intended for Asset transforms.

View source (opens new window)

Arguments

• $arguments (array (opens new window))

Returns

array (opens new window), string (opens new window)

wrapInNonNull()

Wrap a GQL object type in a NonNull type.

View source (opens new window)

Arguments

• $type

Returns

mixed