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

SchemaScaffolder

class SchemaScaffolder implements ManagerMutatorInterface

The entry point for a GraphQL scaffolding definition. Holds DataObject type definitions, and their nested Mutation/Query definitions.

Traits

Extensible

Constants

ALL

CREATE

READ

UPDATE

DELETE

READ_ONE

Methods

static SchemaScaffolder
createFromConfig(array $config)

Create from an array, e.g. derived from YAML.

__construct()

Constructor.

DataObjectScaffolder
type(string $class)

Finds or makes a DataObject definition.

QueryScaffolder|ListQueryScaffolder
query(string $name, string $class, callable|OperationResolver $resolver = null)

Find or make a query.

bool|MutationScaffolder
mutation(string $name, string $class, callable|OperationResolver $resolver = null)

Find or make a mutation.

$this
removeMutation(string $name)

Removes a mutation.

$this
removeQuery(string $name)

Removes a query.

DataObjectScaffolder[]
getTypes()

No description

bool
hasType(string $dataObjectClass)

Returns true if the type has been added to the scaffolder

OperationList
getQueries()

No description

array
getNestedQueries()

Gets all nested queries for all types

OperationList
getMutations()

No description

addToManager(Manager $manager)

Adds every DataObject and its dependencies to the Manager.

Details

at line 61
static SchemaScaffolder createFromConfig(array $config)

Create from an array, e.g. derived from YAML.

Parameters

array $config

Return Value

SchemaScaffolder

Exceptions

InvalidArgumentException

at line 116
__construct()

Constructor.

at line 129
DataObjectScaffolder type(string $class)

Finds or makes a DataObject definition.

Parameters

string $class

Return Value

DataObjectScaffolder

Exceptions

InvalidArgumentException

at line 155
QueryScaffolder|ListQueryScaffolder query(string $name, string $class, callable|OperationResolver $resolver = null)

Find or make a query.

Parameters

string $name
string $class
callable|OperationResolver $resolver

Return Value

QueryScaffolder|ListQueryScaffolder

at line 181
bool|MutationScaffolder mutation(string $name, string $class, callable|OperationResolver $resolver = null)

Find or make a mutation.

Parameters

string $name
string $class
callable|OperationResolver $resolver

Return Value

bool|MutationScaffolder

at line 203
$this removeMutation(string $name)

Removes a mutation.

Parameters

string $name

Return Value

$this

at line 217
$this removeQuery(string $name)

Removes a query.

Parameters

string $name

Return Value

$this

at line 227
DataObjectScaffolder[] getTypes()

Return Value

DataObjectScaffolder[]

at line 238
bool hasType(string $dataObjectClass)

Returns true if the type has been added to the scaffolder

Parameters

string $dataObjectClass

Return Value

bool

at line 252
OperationList getQueries()

Return Value

OperationList

at line 261
array getNestedQueries()

Gets all nested queries for all types

Return Value

array

at line 274
OperationList getMutations()

Return Value

OperationList

at line 284
addToManager(Manager $manager)

Adds every DataObject and its dependencies to the Manager.

Parameters

Manager $manager