1. class
  2. SilverStripe
  3. \
  4. GraphQL
  5. \
  6. Manager

Manager

class Manager implements ConfigurationApplier

Manager is the master container for a graphql endpoint, and contains all queries, mutations, and types.

Instantiate with {see Manager::createFromConfig()} with a config array.

Traits

Injectable
A class that can be instantiated or replaced via DI
Extensible
Allows an object to have extensions applied to it.
Configurable
Provides extensions to this object to integrate it with standard config API methods.
CustomMethods
Allows an object to declare a set of custom methods

Constants

QUERY_ROOT

MUTATION_ROOT

TYPES_ROOT

Methods

static Injectable
create(array $args)

An implementation of the factory method, allows you to create an instance of a class

from Injectable
static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

from Injectable
mixed
__call(string $method, array $arguments)

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

from CustomMethods
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

from CustomMethods
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

from CustomMethods
static bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

from Extensible
static 
remove_extension(string $extension)

Remove an extension from a class.

from Extensible
static array
get_extensions(string $class = null, bool $includeArgumentString = false)

No description

from Extensible
static array|null
get_extra_config_sources(string $class = null)

Get extra config sources for this class

from Extensible
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

from Extensible
array
invokeWithExtensions(string $method, mixed $arguments)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

from Extensible
array
extend(string $method, mixed $arguments)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

from Extensible
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

from Extensible
bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

from Extensible
Extension[]
getExtensionInstances()

Get all extension instances for this specific object instance.

from Extensible
static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

from Configurable
mixed
stat(string $name) deprecated

Get inherited config value

from Configurable
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

from Configurable
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

from Configurable
QueryMiddleware[]
getMiddlewares()

No description

$this
setMiddlewares(QueryMiddleware[] $middlewares)

No description

$this
addMiddleware(QueryMiddleware $middleware)

No description

__construct(string $schemaKey = null)

No description

static Manager
createFromConfig($config, string $schemaKey = null) deprecated

No description

Manager
configure()

Applies a configuration based on the schemaKey property

applyConfig(array $config)

No description

Schema
schema()

Build the main Schema instance that represents the final schema for this endpoint

array
query(string $query, array $params = [])

Execute an arbitrary operation (mutation / query) on this schema.

ExecutionResult|array
queryAndReturnResult(string $query, array $params = [])

Evaluate query via middleware

addType(Type $type, string $name = '')

Register a new type

Type
getType(string $name)

Return a type definition by name

boolean
hasType(string $name)

No description

addQuery(array|Closure $query, string $name)

Register a new Query. Query can be defined as a closure to ensure dependent types are lazy loaded.

array
getQuery(string $name)

Get a query by name

addMutation(array|Closure $mutation, string $name)

Register a new mutation. Mutations can be callbacks to ensure dependent types are lazy-loaded.

array
getMutation(string $name)

Get a mutation by name

string
getSchemaKey()

No description

$this
setSchemaKey(string $schemaKey)

No description

static array
formatError(Error $exception)

More verbose error display defaults.

$this
setMember(Member $member)

Set the Member for the current context

Member
getMember()

Get the Member for the current context either from a previously set value or the current user

string
getQueryFromPersistedID($id)

get query from persisted id, return null if not found

$this
addContext(string $key, any $value)

No description

array
serialiseResult(ExecutionResult $executionResult)

Serialise a Graphql result object for output

Details

in Injectable at line 26
static Injectable create(array $args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class Optional classname to create, if the called class should not be used

Return Value

Injectable The singleton instance

in CustomMethods at line 50
mixed __call(string $method, array $arguments)

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

in CustomMethods at line 144
bool hasMethod(string $method)

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Parameters

string $method

Return Value

bool

in CustomMethods at line 172
array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom include methods added dynamically at runtime

Return Value

array Map of method names with lowercase keys

in Extensible at line 163
static bool add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

Parameters

string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
string $extension Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

in Extensible at line 224
static remove_extension(string $extension)

Remove an extension from a class.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Parameters

string $extension class name of an {@link Extension} subclass, without parameters

in Extensible at line 264
static array get_extensions(string $class = null, bool $includeArgumentString = false)

Parameters

string $class If omitted, will get extensions for the current class
bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array Numeric array of either {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

in Extensible at line 298
static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class Name of class. If left null will return for the current class

Return Value

array|null

in Extensible at line 359
static bool has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension Class to check extension for, or the extension name to check if the second argument is null.
string $requiredExtension If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.
boolean $strict if the extension has to match the required extension and not be a subclass

Return Value

bool Flag if the extension exists

in Extensible at line 395
array invokeWithExtensions(string $method, mixed $arguments)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method the method name to call
mixed $arguments List of arguments

Return Value

array List of results with nulls filtered out

in Extensible at line 424
array extend(string $method, mixed $arguments)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

Parameters

string $method the name of the method to call on each extension
mixed $arguments &...$arguments

Return Value

array

in Extensible at line 465
Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

in Extensible at line 494
bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension Classname of an {@link Extension} subclass without parameters

Return Value

bool

in Extensible at line 508
Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

See {@link get_extensions()} to get all applied extension classes for this class (not the instance).

This method also provides lazy-population of the extension_instances property.

Return Value

Extension[] Map of {@link DataExtension} instances, keyed by classname.

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 94
QueryMiddleware[] getMiddlewares()

Return Value

QueryMiddleware[]

at line 103
$this setMiddlewares(QueryMiddleware[] $middlewares)

Parameters

QueryMiddleware[] $middlewares

Return Value

$this

at line 113
$this addMiddleware(QueryMiddleware $middleware)

Parameters

QueryMiddleware $middleware

Return Value

$this

at line 147
__construct(string $schemaKey = null)

Parameters

string $schemaKey

at line 160
static Manager createFromConfig($config, string $schemaKey = null) deprecated

deprecated 4.0

Parameters

$config
string $schemaKey

Return Value

Manager

at line 175
Manager configure()

Applies a configuration based on the schemaKey property

Return Value

Manager

Exceptions

Exception

at line 195
applyConfig(array $config)

Parameters

array $config

at line 289
Schema schema()

Build the main Schema instance that represents the final schema for this endpoint

Return Value

Schema

at line 335
array query(string $query, array $params = [])

Execute an arbitrary operation (mutation / query) on this schema.

Note because middleware may produce serialised responses we need to conditionally normalise to serialised array on output from object -> array.

Parameters

string $query Raw query
array $params List of arguments given for this operation

Return Value

array

at line 353
ExecutionResult|array queryAndReturnResult(string $query, array $params = [])

Evaluate query via middleware

Parameters

string $query
array $params

Return Value

ExecutionResult|array Result as either source object result, or serialised as array.

at line 372
addType(Type $type, string $name = '')

Register a new type

Parameters

Type $type
string $name An optional identifier for this type (defaults to 'name' attribute in type definition). Needs to be unique in schema.

at line 387
Type getType(string $name)

Return a type definition by name

Parameters

string $name

Return Value

Type

at line 401
boolean hasType(string $name)

Parameters

string $name

Return Value

boolean

at line 413
addQuery(array|Closure $query, string $name)

Register a new Query. Query can be defined as a closure to ensure dependent types are lazy loaded.

Parameters

array|Closure $query
string $name Identifier for this query (unique in schema)

at line 424
array getQuery(string $name)

Get a query by name

Parameters

string $name

Return Value

array

at line 436
addMutation(array|Closure $mutation, string $name)

Register a new mutation. Mutations can be callbacks to ensure dependent types are lazy-loaded.

Parameters

array|Closure $mutation
string $name Identifier for this mutation (unique in schema)

at line 447
array getMutation(string $name)

Get a mutation by name

Parameters

string $name

Return Value

array

at line 455
string getSchemaKey()

Return Value

string

at line 464
$this setSchemaKey(string $schemaKey)

Parameters

string $schemaKey

Return Value

$this

at line 496
static array formatError(Error $exception)

More verbose error display defaults.

Parameters

Error $exception

Return Value

array

at line 523
$this setMember(Member $member)

Set the Member for the current context

Parameters

Member $member

Return Value

$this

at line 534
Member getMember()

Get the Member for the current context either from a previously set value or the current user

Return Value

Member

at line 545
string getQueryFromPersistedID($id)

get query from persisted id, return null if not found

Parameters

$id

Return Value

string | null

at line 581
$this addContext(string $key, any $value)

Parameters

string $key
any $value

Return Value

$this

at line 600
array serialiseResult(ExecutionResult $executionResult)

Serialise a Graphql result object for output

Parameters

ExecutionResult $executionResult

Return Value

array