Gql
- Type
- Class
- Namespace
- craft\helpers
- Inherits
- craft\helpers\Gql
- Since
- 3.3.0
Class Gql
Public Methods
| Method | Description |
|---|---|
| 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. |
| 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). |
canQueryAssets()
Return true if active schema can query assets.
Returns
canQueryCategories()
Return true if active schema can query categories.
Returns
canQueryEntries()
Return true if active schema can query entries.
Returns
canQueryGlobalSets()
Return true if active schema can query global sets.
Returns
canQueryTags()
Return true if active schema can query tags.
Returns
canQueryUsers()
Return true if active schema can query users.
Returns
canSchema()
Returns true if the active schema can perform the action on the scope.
Arguments
Returns
Throws
createFullAccessSchema()
- Since
- 3.3.12
Creates a temporary schema with full access to the GraphQL API.
Returns
extractAllowedEntitiesFromSchema()
Extracts all the allowed entities from the active schema for the action.
Arguments
$action(string) – The action for which the entities should be extracted. Defaults to "read"
Returns
getUnionType()
Get (and create if needed) a union type by name, included types and a resolver funcion.
Arguments
Returns
mixed
isSchemaAwareOf()
Returns true if the active schema is aware of the provided scope(s).