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 (opens new window)
# Protected Properties
| Property | Description |
|---|---|
| argumentManager | craft\gql\ArgumentManager |
| argumentName | string (opens new window) |
# Public Methods
| Method | Description |
|---|---|
| handleArgumentCollection() | Handle an argument collection |
| setArgumentManager() | Set the current argument manager. Required for recursive argument preparation. |
# handleArgumentCollection()
Handle an argument collection
View source (opens new window)
Arguments
$argumentList(array (opens new window)) – Argument list to be used for the query
Returns
mixed
# Protected Methods
| Method | Description |
|---|---|
| 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 (opens new window)
Arguments
$elementType(string (opens new window))$criteriaList(array (opens new window))
Returns
# handleArgument()
Handle a single argument value
View source (opens new window)
Arguments
$argumentValue
Returns
mixed
# prepareRelatedTo()
Prepare the relatedTo argument.
View source (opens new window)
Arguments
$relatedTo(array (opens new window))