Skip to content

RelationArgumentHandler

Type
Abstract Class
Namespace
craft\gql\base
Inherits
craft\gql\base\RelationArgumentHandler » craft\gql\base\ArgumentHandler
Implements
craft\gql\base\ArgumentHandlerInterface
Extended by
craft\gql\handlers\RelatedAssets, craft\gql\handlers\RelatedCategories, craft\gql\handlers\RelatedEntries, craft\gql\handlers\RelatedTags, craft\gql\handlers\RelatedUsers
Since
3.6.0

Class RelationArgumentHandler

View source

Protected Properties

PropertyDescription
argumentManagercraft\gql\ArgumentManager
argumentNamestring

Public Methods

MethodDescription
handleArgumentCollection()Handle an argument collection
setArgumentManager()Set the current argument manager. Required for recursive argument preparation.

handleArgumentCollection()

Handle an argument collection

View source

Arguments

  • $argumentList (array) – Argument list to be used for the query

Returns

array

Protected Methods

MethodDescription
getIds()Get the IDs of elements returned by configuring the provided element query with given criteria.
handleArgument()Handle a single argument value
prepareRelatedTo()Prepare the relatedTo argument.

getIds()

Get the IDs of elements returned by configuring the provided element query with given criteria.

View source

Arguments

Returns

int[][]

handleArgument()

Handle a single argument value

View source

Arguments

  • $argumentValue (mixed)

Returns

mixed

prepareRelatedTo()

Prepare the relatedTo argument.

View source

Arguments

Returns

array