class ModelMutation extends Mutation implements ModelOperation (View source)

Defines a mutation created by a model

Traits

Used for a variety of classes that rely on SchemaModelInterface

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

Allows adding, loading, and sorting of plugins

Constants

DEFAULT_TYPE

Methods

static Injectable
create(array ...$args)

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

static Injectable
singleton(string $class = null)

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

static Config_ForClass
config()

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

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

addPlugin(string $pluginName, array $config = [])

No description

removePlugin(string $pluginName)

No description

mergePlugins(array $plugins)

No description

setPlugins(array $plugins)

No description

setDefaultPlugins(array $plugins)

No description

array
getPlugins(bool $inheritDefaults = true)

No description

array
getDefaultPlugins()

No description

bool
hasPlugin(string $identifier)

No description

loadPlugins()

Translates all the ID and config settings to first class instances

array
getSortedPlugins()

Sorts the before/after of plugins using topological sort

__construct(SchemaModelInterface $model, string $mutationName, array|string $config = [])

ModelMutation constructor.

static array
parseName(string $def)

Negotiates a variety of syntax that can appear in a field name definition.

from  Field
mixed
applyConfig(array $config)

No description

from  Field
addArg(string $argName, null $config, callable|null $callback = null)

No description

from  Field
setArgs(array $args)

No description

from  Field
mergeWith(Field $field)

No description

from  Field
bool
isList()

No description

from  Field
bool
isRequired()

No description

from  Field
void
validate()

No description

from  Field
setType($type, bool $required = false)

No description

from  Field
setTypeAsModel(string $modelTypeDef)

No description

from  Field
string|null
getTypeAsModel()

No description

from  Field
string|null
getName()

No description

from  Field
setName(string $name)

No description

from  Field
string|null
getType()

No description

from  Field
array
getArgs()

No description

from  Field
getEncodedType()

No description

from  Field
string
getNamedType()

Gets the name of the type, ignoring any nonNull/listOf wrappers

from  Field
setNamedType(string $name)

[MyType!]! becomes [MyNewType!]!

from  Field
getEncodedResolver(string|null $typeName = null)

No description

from  Field
string|null
getDescription()

No description

from  Field
setDescription(string|null $description)

No description

from  Field
ResolverReference|null
getResolver()

No description

from  Field
setResolver(array|string|ResolverReference|null $resolver)

No description

from  Field
array|null
getResolverContext()

No description

from  Field
setResolverContext(array|null $resolverContext)

No description

from  Field
addResolverContext(string $key, $value)

No description

from  Field
addResolverMiddleware(array|string|ResolverReference|null $resolver, array|null $context = null)

No description

from  Field
addResolverAfterware(array|string|ResolverReference|null $resolver, array|null $context = null)

No description

from  Field
array
getResolverMiddlewares()

No description

from  Field
array
getResolverAfterwares()

No description

from  Field
string
getSignature()

No description

from  Field
void
validatePlugin(string $pluginName, $plugin)

No description

getModel()

No description

setModel(SchemaModelInterface $model)

No description

Details

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

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

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$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

PluginConsumer addPlugin(string $pluginName, array $config = [])

Parameters

string $pluginName
array $config

Return Value

PluginConsumer

PluginConsumer removePlugin(string $pluginName)

Parameters

string $pluginName

Return Value

PluginConsumer

PluginConsumer mergePlugins(array $plugins)

Parameters

array $plugins

Return Value

PluginConsumer

PluginConsumer setPlugins(array $plugins)

Parameters

array $plugins

Return Value

PluginConsumer

Exceptions

SchemaBuilderException

PluginConsumer setDefaultPlugins(array $plugins)

Parameters

array $plugins

Return Value

PluginConsumer

Exceptions

SchemaBuilderException

array getPlugins(bool $inheritDefaults = true)

Parameters

bool $inheritDefaults

Return Value

array

array getDefaultPlugins()

Return Value

array

bool hasPlugin(string $identifier)

Parameters

string $identifier

Return Value

bool

PluginRegistry getPluginRegistry()

Return Value

PluginRegistry

Generator loadPlugins()

Translates all the ID and config settings to first class instances

Return Value

Generator

Exceptions

SchemaBuilderException
CircularDependencyException
ElementNotFoundException

array getSortedPlugins()

Sorts the before/after of plugins using topological sort

Return Value

array

Exceptions

CircularDependencyException
ElementNotFoundException

__construct(SchemaModelInterface $model, string $mutationName, array|string $config = [])

ModelMutation constructor.

Parameters

SchemaModelInterface $model
string $mutationName
array|string $config

Exceptions

SchemaBuilderException

static array parseName(string $def)

Negotiates a variety of syntax that can appear in a field name definition.

fieldName fieldName(arg1: String!, arg2: Int) fieldName(arg1: String! = "foo")

Parameters

string $def

Return Value

array

Exceptions

SchemaBuilderException

mixed applyConfig(array $config)

Parameters

array $config

Return Value

mixed

Exceptions

SchemaBuilderException

Field addArg(string $argName, null $config, callable|null $callback = null)

Parameters

string $argName
null $config
callable|null $callback

Return Value

Field

Field setArgs(array $args)

Parameters

array $args

Return Value

Field

Exceptions

SchemaBuilderException

Field mergeWith(Field $field)

Parameters

Field $field

Return Value

Field

bool isList()

Return Value

bool

bool isRequired()

Return Value

bool

void validate()

Return Value

void

Exceptions

SchemaBuilderException

Field setType($type, bool $required = false)

Parameters

$type
bool $required

Return Value

Field

Exceptions

SchemaBuilderException

Field setTypeAsModel(string $modelTypeDef)

Parameters

string $modelTypeDef

Return Value

Field

string|null getTypeAsModel()

Return Value

string|null

string|null getName()

Return Value

string|null

Field setName(string $name)

Parameters

string $name

Return Value

Field

string|null getType()

Return Value

string|null

array getArgs()

Return Value

array

EncodedType getEncodedType()

Return Value

EncodedType

Exceptions

SchemaBuilderException

string getNamedType()

Gets the name of the type, ignoring any nonNull/listOf wrappers

Return Value

string

Field setNamedType(string $name)

[MyType!]! becomes [MyNewType!]!

Parameters

string $name

Return Value

Field

Exceptions

SchemaBuilderException

EncodedResolver getEncodedResolver(string|null $typeName = null)

Parameters

string|null $typeName

Return Value

EncodedResolver

Exceptions

SchemaBuilderException

string|null getDescription()

Return Value

string|null

Field setDescription(string|null $description)

Parameters

string|null $description

Return Value

Field

ResolverReference|null getResolver()

Return Value

ResolverReference|null

Field setResolver(array|string|ResolverReference|null $resolver)

Parameters

array|string|ResolverReference|null $resolver

Return Value

Field

array|null getResolverContext()

Return Value

array|null

Field setResolverContext(array|null $resolverContext)

Parameters

array|null $resolverContext

Return Value

Field

Field addResolverContext(string $key, $value)

Parameters

string $key
$value

Return Value

Field

Field addResolverMiddleware(array|string|ResolverReference|null $resolver, array|null $context = null)

Parameters

array|string|ResolverReference|null $resolver
array|null $context

Return Value

Field

Field addResolverAfterware(array|string|ResolverReference|null $resolver, array|null $context = null)

Parameters

array|string|ResolverReference|null $resolver
array|null $context

Return Value

Field

array getResolverMiddlewares()

Return Value

array

array getResolverAfterwares()

Return Value

array

string getSignature()

Return Value

string

Exceptions

SchemaBuilderException
Exception

void validatePlugin(string $pluginName, $plugin)

Parameters

string $pluginName
$plugin

Return Value

void

Exceptions

SchemaBuilderException

ModelAware setModel(SchemaModelInterface $model)

Parameters

SchemaModelInterface $model

Return Value

ModelAware