Skip to content

Gql

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\Gql
Since
3.3.0

Class Gql

View source

Public Methods

MethodDescription
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.
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.
canQueryDrafts()Return true if active schema can query for drafts.
canQueryEntries()Return true if active schema can query entries.
canQueryGlobalSets()Return true if active schema can query global sets.
canQueryInactiveElements()Return true if active schema can query for inactive elements.
canQueryRevisions()Return true if active schema can query for revisions.
canQueryTags()Return true if active schema can query tags.
canQueryUsers()Return true if active schema can query users.
canSchema()Returns whether the given component is included in a schema, for the given action.
createFullAccessSchema()Creates a temporary schema with full access to the GraphQL API.
eagerLoadComplexity()Shorthand for returning the complexity function for an eager-loaded field.
extractAllowedEntitiesFromSchema()Extracts all the allowed entities from a schema for the given action.
extractEntityAllowedActions()Return a list of all the actions the current schema is allowed for a given entity.
getAllowedSites()Get a list of all allowed sites by Schema.
getFieldNameWithAlias()Looking at the resolve information and the source queried, return the field name or it's alias, if used.
getSchemaContainedEntryTypes()Return all entry types a given (or loaded) schema contains.
getSchemaContainedNestedEntryFields()Returns all nested entry fields a given (or loaded) schema contains.
getSchemaContainedSections()Returns all sections a given (or loaded) schema contains.
getUnionType()Get (and create if needed) a union type by name, included types and a resolver function.
isIntrospectionQuery()Returns whether the given GraphQL query looks like an introspection query.
isSchemaAwareOf()Returns whether the given component(s) are included in a schema’s scope.
nPlus1Complexity()Shorthand for returning the complexity function for a field that will generate a single query for every iteration.
prepareTransformArguments()Prepare arguments intended for asset transforms.
relatedArgumentComplexity()Shorthand for returning the complexity function for a field that will add a single query to execution.
singleQueryComplexity()Shorthand for returning the complexity function for a field that will add a single query to execution.
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

Arguments

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

Returns

mixed

canMutateAssets()

Since
3.5.0

Return true if active schema can mutate assets.

View source

Arguments

Returns

boolean

canMutateCategories()

Since
3.5.0

Return true if active schema can mutate categories.

View source

Arguments

Returns

boolean

canMutateGlobalSets()

Since
3.5.0

Return true if active schema can mutate global sets.

View source

Arguments

Returns

boolean

canMutateTags()

Since
3.5.0

Return true if active schema can mutate tags.

View source

Arguments

Returns

boolean

canQueryAssets()

Return true if active schema can query assets.

View source

Arguments

Returns

boolean

canQueryCategories()

Return true if active schema can query categories.

View source

Arguments

Returns

boolean

canQueryDrafts()

Since
3.6.8

Return true if active schema can query for drafts.

View source

Arguments

Returns

boolean

canQueryEntries()

Return true if active schema can query entries.

View source

Arguments

Returns

boolean

canQueryGlobalSets()

Return true if active schema can query global sets.

View source

Arguments

Returns

boolean

canQueryInactiveElements()

Since
3.6.8

Return true if active schema can query for inactive elements.

View source

Arguments

Returns

boolean

canQueryRevisions()

Since
3.6.8

Return true if active schema can query for revisions.

View source

Arguments

Returns

boolean

canQueryTags()

Return true if active schema can query tags.

View source

Arguments

Returns

boolean

canQueryUsers()

Return true if active schema can query users.

View source

Arguments

Returns

boolean

canSchema()

Returns whether the given component is included in a schema, for the given action.

View source

Arguments

  • $component (string) – The component to check.
  • $action (string) – The action. Defaults to "read".
  • $schema (craft\models\GqlSchema, null) – The GraphQL schema. If none is provided, the active schema will be used.

Returns

boolean

Throws

createFullAccessSchema()

Since
3.4.0

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

View source

Returns

craft\models\GqlSchema

eagerLoadComplexity()

Since
3.6.0

Shorthand for returning the complexity function for an eager-loaded field.

View source

Returns

callable

extractAllowedEntitiesFromSchema()

Extracts all the allowed entities from a schema for the given action.

View source

Arguments

  • $action (string) – The action for which the entities should be extracted. Defaults to "read".
  • $schema (craft\models\GqlSchema, null) – The GraphQL schema. If none is provided, the active schema will be used.

Returns

array

extractEntityAllowedActions()

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

View source

Arguments

Returns

array

getAllowedSites()

Since
4.0.0

Get a list of all allowed sites by Schema.

View source

Arguments

Returns

craft\models\Site[]

getFieldNameWithAlias()

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

View source

Arguments

  • $resolveInfo (\GraphQL\Type\Definition\ResolveInfo)
  • $source (mixed)
  • $context (array, null)

Returns

string

getSchemaContainedEntryTypes()

Return all entry types a given (or loaded) schema contains.

View source

Arguments

  • $schema

Returns

craft\models\EntryType[]

getSchemaContainedNestedEntryFields()

Since
5.0.0

Returns all nested entry fields a given (or loaded) schema contains.

View source

Arguments

  • $schema

Returns

craft\base\ElementContainerFieldInterface[]

getSchemaContainedSections()

Since
5.0.0

Returns all sections a given (or loaded) schema contains.

View source

Arguments

  • $schema

Returns

craft\models\Section[]

getUnionType()

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

View source

Arguments

  • $typeName (string) – The union type name.
  • $includedTypes (array) – The type the union should include
  • $resolveFunction (?callable) – The resolver function to use to resolve a specific type. If not provided, a default one will be used that is able to resolve Craft elements.

Returns

mixed

isIntrospectionQuery()

Since
4.9.6

Returns whether the given GraphQL query looks like an introspection query.

View source

Arguments

Returns

boolean

isSchemaAwareOf()

Returns whether the given component(s) are included in a schema’s scope.

View source

Arguments

Returns

boolean

nPlus1Complexity()

Since
3.6.0

Shorthand for returning the complexity function for a field that will generate a single query for every iteration.

View source

Returns

callable

prepareTransformArguments()

Since
3.5.3

Prepare arguments intended for asset transforms.

View source

Arguments

Returns

array, string

relatedArgumentComplexity()

Since
3.6.7

Shorthand for returning the complexity function for a field that will add a single query to execution.

View source

Arguments

  • $baseComplexity (integer) – The base complexity to use. Defaults to a single query.

Returns

callable

singleQueryComplexity()

Since
3.6.0

Shorthand for returning the complexity function for a field that will add a single query to execution.

View source

Returns

callable

wrapInNonNull()

Wrap a GQL object type in a NonNull type.

View source

Arguments

  • $type (mixed)

Returns

mixed