ElementResolver
- Type
- Abstract Class
- Namespace
- craft\gql\base
- Inherits
- craft\gql\base\ElementResolver » craft\gql\base\Resolver
- Extended by
- craft\gql\resolvers\elements\Asset, craft\gql\resolvers\elements\Category, craft\gql\resolvers\elements\Entry, craft\gql\resolvers\elements\GlobalSet, craft\gql\resolvers\elements\MatrixBlock, craft\gql\resolvers\elements\Tag, craft\gql\resolvers\elements\User
- Since
- 3.3.0
Class ElementResolver
View source (opens new window)
# Protected Properties
Property | Description |
---|---|
eagerLoadableFieldsByContext | array (opens new window) – Cache fields by context. |
# Public Methods
Method | Description |
---|---|
getArrayableArguments() | Returns a list of all the arguments that can be accepted as arrays. |
prepareArguments() | Prepare arguments for use, converting to array where applicable. |
resolve() | Resolve a field to its value. |
resolveCount() | Resolve an element query to a total count of elements. |
resolveOne() | Resolve an element query to a single result. |
# resolve()
Resolve a field to its value.
View source (opens new window)
Arguments
$source
(mixed
) – The parent data source to use for resolving this field$arguments
(array (opens new window)) – Arguments for resolving this field.$context
(mixed
) – The context shared between all resolvers$resolveInfo
(\GraphQL\Type\Definition\ResolveInfo
) – The resolve information
# resolveCount()
Resolve an element query to a total count of elements.
View source (opens new window)
Arguments
$source
$arguments
(array (opens new window))$context
$resolveInfo
(\GraphQL\Type\Definition\ResolveInfo
)
Returns
craft\base\ElementInterface, null (opens new window), mixed
# resolveOne()
Resolve an element query to a single result.
View source (opens new window)
Arguments
$source
$arguments
(array (opens new window))$context
$resolveInfo
(\GraphQL\Type\Definition\ResolveInfo
)
Returns
craft\base\ElementInterface, null (opens new window), mixed
# Protected Methods
Method | Description |
---|---|
extractEagerLoadCondition() | Extract eager load conditions for a given resolve information. Preferably at the very top of the query. |
prepareElementQuery() | Prepare an element query for given resolution argument set. |
prepareQuery() | Prepare an element Query based on the source, arguments and the field name on the source. |
# prepareElementQuery()
Prepare an element query for given resolution argument set.
View source (opens new window)
Arguments
$source
$arguments
(array (opens new window))$context
$resolveInfo
(\GraphQL\Type\Definition\ResolveInfo
)
Returns
craft\elements\db\ElementQuery, array (opens new window)
# prepareQuery()
Prepare an element Query based on the source, arguments and the field name on the source.
View source (opens new window)
Arguments
$source
(mixed
) – The source. Null if top-level field being resolved.$arguments
(array (opens new window)) – Arguments to apply to the query.$fieldName
(null (opens new window)) – Field name to resolve on the source, if not a top-level resolution.
Returns
mixed