1. class
  2. SilverStripe
  3. \
  4. GraphQL
  5. \
  6. Scaffolding
  7. \
  8. Scaffolders
  9. \
  10. ListQueryScaffolder

ListQueryScaffolder

class ListQueryScaffolder extends QueryScaffolder

Scaffolds a GraphQL query field.

Traits

PermissionCheckerAware
DataObjectTypeTrait
Offers a few helper methods for classes that are DataObject subclass bound.
Chainable
Extensible

Methods

$this
setChainableParent(DataObjectScaffolder|SchemaScaffolder $parent)

Set parent

from Chainable
DataObjectScaffolder|SchemaScaffolder
end()

No description

from Chainable
string
getDescription()

No description

from OperationScaffolder
OperationScaffolder
setDescription(string $description)

No description

from OperationScaffolder
static string|null
getClassFromIdentifier(string $name)

No description

from OperationScaffolder
static string|null
getIdentifier(string|OperationScaffolder $instOrClass)

No description

from OperationScaffolder
static array
getOperations()

Gets a map of operation identifiers to their classes

from OperationScaffolder
__construct(string $operationName = null, string $typeName = null, OperationResolver|callable|null $resolver = null, string $class = null)

QueryScaffolder constructor.

from QueryScaffolder
$this
addArgs(array $argData)

Adds args to the operation

from OperationScaffolder
$this
addArg(string $argName, string $typeStr, string $description = null, mixed $defaultValue = null)

No description

from OperationScaffolder
$this
setArgDescriptions(array $argData)

Sets descriptions of arguments [ 'Email' => 'The email of the user' ]

from OperationScaffolder
$this
setArgDescription(string $argName, string $description)

Sets a single arg description

from OperationScaffolder
$this
setArgDefaults(array $argData)

Sets argument defaults [ 'Featured' => true ]

from OperationScaffolder
$this
setArgDefault(string $argName, mixed $default)

Sets a default for a single arg

from OperationScaffolder
$this
setArgsRequired(array $argData)

Sets operation arguments as required or not [ 'ID' => true ]

from OperationScaffolder
OperationScaffolder
setArgRequired(string $argName, boolean $required)

Sets an operation argument as required or not

from OperationScaffolder
string
getName()

No description

from OperationScaffolder
$this
setName(string $name)

No description

from OperationScaffolder
ArrayList
getArgs()

No description

from OperationScaffolder
$this
setTypeName(string $typeName)

Type name

from OperationScaffolder
string
getTypeName()

No description

from QueryScaffolder
$this
removeArg(string $arg)

No description

from OperationScaffolder
$this
removeArgs(array $args)

No description

from OperationScaffolder
callable|OperationResolver
getResolver()

No description

from OperationScaffolder
$this
setResolver(callable|OperationResolver|string $resolver)

No description

from OperationScaffolder
applyConfig(array $config)

No description

string
getDataObjectClass()

No description

from DataObjectTypeTrait
DataObject
getDataObjectInstance()

No description

from DataObjectTypeTrait
$this
setDataObjectClass(string $class)

Sets the DataObject name

from DataObjectTypeTrait
addToManager(Manager $manager)

No description

$this
setNested(bool $bool)

Set to true if this query is a nested field and should not appear in the root query field

from QueryScaffolder
$this
setPermissionChecker(QueryPermissionChecker $checker)

No description

from PermissionCheckerAware
QueryPermissionChecker
getPermissionChecker()

No description

from PermissionCheckerAware
$this
setUsePagination(bool $bool)

No description

int
getPaginationLimit()

No description

$this
setPaginationLimit(int $int)

No description

int
getMaximumPaginationLimit()

No description

$this
setMaximumPaginationLimit(int $int)

No description

$this
addSortableFields(array $fields)

No description

array
getSortableFields()

No description

mixed
scaffold(Manager $manager)

No description

Details

in Chainable at line 21
$this setChainableParent(DataObjectScaffolder|SchemaScaffolder $parent)

Set parent

Parameters

DataObjectScaffolder|SchemaScaffolder $parent

Return Value

$this

in Chainable at line 31
DataObjectScaffolder|SchemaScaffolder end()

Return Value

DataObjectScaffolder|SchemaScaffolder

in OperationScaffolder at line 59
string getDescription()

Return Value

string

in OperationScaffolder at line 68
OperationScaffolder setDescription(string $description)

Parameters

string $description

Return Value

OperationScaffolder

in OperationScaffolder at line 79
static string|null getClassFromIdentifier(string $name)

Parameters

string $name

Return Value

string|null

in OperationScaffolder at line 90
static string|null getIdentifier(string|OperationScaffolder $instOrClass)

Parameters

string|OperationScaffolder $instOrClass

Return Value

string|null

in OperationScaffolder at line 103
static array getOperations()

Gets a map of operation identifiers to their classes

Return Value

array

in QueryScaffolder at line 34
__construct(string $operationName = null, string $typeName = null, OperationResolver|callable|null $resolver = null, string $class = null)

QueryScaffolder constructor.

Parameters

string $operationName
string $typeName
OperationResolver|callable|null $resolver
string $class

in OperationScaffolder at line 148
$this addArgs(array $argData)

Adds args to the operation

Ex: [ 'MyArg' => 'String!', 'MyOtherArg' => 'Int', 'MyCustomArg' => new InputObjectType([ ]

Parameters

array $argData

Return Value

$this

in OperationScaffolder at line 165
$this addArg(string $argName, string $typeStr, string $description = null, mixed $defaultValue = null)

Parameters

string $argName
string $typeStr
string $description
mixed $defaultValue

Return Value

$this

in OperationScaffolder at line 182
$this setArgDescriptions(array $argData)

Sets descriptions of arguments [ 'Email' => 'The email of the user' ]

Parameters

array $argData

Return Value

$this

in OperationScaffolder at line 208
$this setArgDescription(string $argName, string $description)

Sets a single arg description

Parameters

string $argName
string $description

Return Value

$this

in OperationScaffolder at line 221
$this setArgDefaults(array $argData)

Sets argument defaults [ 'Featured' => true ]

Parameters

array $argData

Return Value

$this

in OperationScaffolder at line 247
$this setArgDefault(string $argName, mixed $default)

Sets a default for a single arg

Parameters

string $argName
mixed $default

Return Value

$this

in OperationScaffolder at line 260
$this setArgsRequired(array $argData)

Sets operation arguments as required or not [ 'ID' => true ]

Parameters

array $argData

Return Value

$this

in OperationScaffolder at line 286
OperationScaffolder setArgRequired(string $argName, boolean $required)

Sets an operation argument as required or not

Parameters

string $argName
boolean $required

Return Value

OperationScaffolder

in OperationScaffolder at line 294
string getName()

Return Value

string

in OperationScaffolder at line 303
$this setName(string $name)

Parameters

string $name

Return Value

$this

in OperationScaffolder at line 313
ArrayList getArgs()

Return Value

ArrayList

in OperationScaffolder at line 324
$this setTypeName(string $typeName)

Type name

Parameters

string $typeName

Return Value

$this

in QueryScaffolder at line 74
string getTypeName()

Return Value

string

in OperationScaffolder at line 342
$this removeArg(string $arg)

Parameters

string $arg

Return Value

$this

in OperationScaffolder at line 351
$this removeArgs(array $args)

Parameters

array $args

Return Value

$this

in OperationScaffolder at line 361
callable|OperationResolver getResolver()

Return Value

callable|OperationResolver

in OperationScaffolder at line 371
$this setResolver(callable|OperationResolver|string $resolver)

Parameters

callable|OperationResolver|string $resolver Callable, instance of (or classname of) a OperationResolver

Return Value

$this

Exceptions

InvalidArgumentException

at line 128
applyConfig(array $config)

Parameters

array $config

in DataObjectTypeTrait at line 29
string getDataObjectClass()

Return Value

string

in DataObjectTypeTrait at line 52
DataObject getDataObjectInstance()

Return Value

DataObject

in DataObjectTypeTrait at line 65
$this setDataObjectClass(string $class)

Sets the DataObject name

Parameters

string $class

Return Value

$this

at line 164
addToManager(Manager $manager)

Parameters

Manager $manager

Exceptions

Exception

in QueryScaffolder at line 67
$this setNested(bool $bool)

Set to true if this query is a nested field and should not appear in the root query field

Parameters

bool $bool

Return Value

$this

in PermissionCheckerAware at line 17
$this setPermissionChecker(QueryPermissionChecker $checker)

Parameters

QueryPermissionChecker $checker

Return Value

$this

in PermissionCheckerAware at line 27
QueryPermissionChecker getPermissionChecker()

Return Value

QueryPermissionChecker

at line 50
$this setUsePagination(bool $bool)

Parameters

bool $bool

Return Value

$this

at line 59
int getPaginationLimit()

Return Value

int

at line 68
$this setPaginationLimit(int $int)

Parameters

int $int

Return Value

$this

at line 81
int getMaximumPaginationLimit()

Return Value

int

at line 90
$this setMaximumPaginationLimit(int $int)

Parameters

int $int

Return Value

$this

at line 104
$this addSortableFields(array $fields)

Parameters

array $fields

Return Value

$this

at line 119
array getSortableFields()

Return Value

array

at line 179
mixed scaffold(Manager $manager)

Parameters

Manager $manager

Return Value

mixed