1. class
  2. SilverStripe
  3. \
  4. Versioned
  5. \
  6. GraphQL
  7. \
  8. Operations
  9. \
  10. Rollback

Rollback

class Rollback extends MutationScaffolder implements OperationResolver

Scaffolds a "rollback recursive" operation for DataObjects.

rollback[TypeName](ID!, ToVersion!)

Traits

DataObjectTypeTrait
Offers a few helper methods for classes that are DataObject subclass bound.
Chainable
Extensible
Allows an object to have extensions applied to it.
CustomMethods
Allows an object to declare a set of custom methods

Methods

$this
setChainableParent(DataObjectScaffolder|SchemaScaffolder $parent)

Set parent

from Chainable
DataObjectScaffolder|SchemaScaffolder
end()

No description

from Chainable
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
bool
getCloneable()

No description

from OperationScaffolder
$this
setCloneable(bool $cloneable)

No description

from OperationScaffolder
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 $dataObjectClass)

CreateOperationScaffolder constructor.

$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

$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 MutationScaffolder
$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

from OperationScaffolder
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

from MutationScaffolder
mixed
scaffold(Manager $manager)

No description

from MutationScaffolder
array
createDefaultArgs(Manager $manager)

No description

mixed
resolve(mixed $object, array $args, mixed $context, ResolveInfo $info)

Invoked by the Executor class to resolve this mutation / query

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 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 OperationScaffolder at line 65
bool getCloneable()

Return Value

bool

in OperationScaffolder at line 74
$this setCloneable(bool $cloneable)

Parameters

bool $cloneable

Return Value

$this

in OperationScaffolder at line 84
string getDescription()

Return Value

string

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

Parameters

string $description

Return Value

OperationScaffolder

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

Parameters

string $name

Return Value

string|null

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

Parameters

string|OperationScaffolder $instOrClass

Return Value

string|null

in OperationScaffolder at line 127
static array getOperations()

Gets a map of operation identifiers to their classes

Return Value

array

at line 30
__construct(string $dataObjectClass)

CreateOperationScaffolder constructor.

Parameters

string $dataObjectClass

in OperationScaffolder at line 172
$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 189
$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 206
$this setArgDescriptions(array $argData)

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

Parameters

array $argData

Return Value

$this

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

Sets a single arg description

Parameters

string $argName
string $description

Return Value

$this

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

Sets argument defaults [ 'Featured' => true ]

Parameters

array $argData

Return Value

$this

in OperationScaffolder at line 271
$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 284
$this setArgsRequired(array $argData)

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

Parameters

array $argData

Return Value

$this

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

Sets an operation argument as required or not

Parameters

string $argName
boolean $required

Return Value

OperationScaffolder

at line 38
string getName()

Return Value

string

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

Parameters

string $name

Return Value

$this

in OperationScaffolder at line 337
ArrayList getArgs()

Return Value

ArrayList

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

Type name

Parameters

string $typeName

Return Value

$this

in MutationScaffolder at line 65
string getTypeName()

Return Value

string

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

Parameters

string $arg

Return Value

$this

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

Parameters

array $args

Return Value

$this

in OperationScaffolder at line 385
callable|OperationResolver getResolver()

Return Value

callable|OperationResolver

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

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException

in OperationScaffolder at line 418
applyConfig(array $config)

Parameters

array $config

Exceptions

Exception

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

in MutationScaffolder at line 40
addToManager(Manager $manager)

Parameters

Manager $manager

in MutationScaffolder at line 54
mixed scaffold(Manager $manager)

Parameters

Manager $manager

Return Value

mixed

at line 54
array createDefaultArgs(Manager $manager)

Parameters

Manager $manager

Return Value

array

at line 78
mixed resolve(mixed $object, array $args, mixed $context, ResolveInfo $info)

Invoked by the Executor class to resolve this mutation / query

Parameters

mixed $object
array $args
mixed $context
ResolveInfo $info

Return Value

mixed

See also

Executor