class ReadVersions extends ListQueryScaffolder implements OperationResolver

Scaffolds a generic read operation for DataObjects.

Traits

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

Methods

setChainableParent($parent)

No description

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

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

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

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

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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

array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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

Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

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.

getExtensionInstances()

Get all extension instances for this specific object instance.

static string|null
getClassFromIdentifier(string $name)

No description

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

No description

static array
getOperations()

Gets a map of operation identifiers to their classes

__construct(string $dataObjectClass, string $versionTypeName)

ReadOperationScaffolder constructor.

$this
addArgs(array $argData)

Adds visible fields, and optional descriptions.

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

No description

$this
setArgDescriptions(array $argData)

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

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

Sets a single arg description

$this
setArgDefaults(array $argData)

Sets argument defaults [ 'Featured' => true ]

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

Sets a default for a single arg

string
getName()

No description

getArgs()

No description

string
getTypeName()

No description

$this
removeArg(string $arg)

No description

$this
removeArgs(array $args)

No description

$this
setResolver(callable|ResolverInterface|string $resolver)

No description

applyConfig(array $config)

No description

string
getDataObjectClass()

No description

string
typeName()

No description

mixed
getDataObjectInstance()

No description

$this
setDataObjectClass(string $class)

Sets the DataObject name

addToManager(Manager $manager)

No description

$this
setNested($bool)

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

$this
setUsePagination(bool $bool)

No description

$this
addSortableFields(array $fields)

No description

mixed
scaffold(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 9
setChainableParent($parent)

Parameters

$parent

in Chainable at line 16
end()

in CustomMethods at line 47
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 146
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 176
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

in Extensible at line 172
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 236
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 278
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 312
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 373
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 415
array invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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 $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array List of results with nulls filtered out

in Extensible at line 450
array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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 $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

in Extensible at line 497
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 526
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 540
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 51
static string|null getClassFromIdentifier(string $name)

Parameters

string $name

Return Value

string|null

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

Parameters

string|OperationScaffolder $instOrClass

Return Value

string|null

in OperationScaffolder at line 75
static array getOperations()

Gets a map of operation identifiers to their classes

Return Value

array

at line 27
__construct(string $dataObjectClass, string $versionTypeName)

ReadOperationScaffolder constructor.

Parameters

string $dataObjectClass
string $versionTypeName

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

Adds visible fields, and optional descriptions.

Ex: [ 'MyField' => 'Some description', 'MyOtherField' // No description ]

Parameters

array $argData

Return Value

$this

in OperationScaffolder at line 136
$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 153
$this setArgDescriptions(array $argData)

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

Parameters

array $argData

Return Value

$this

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

Sets a single arg description

Parameters

string $argName
string $description

Return Value

$this

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

Sets argument defaults [ 'Featured' => true ]

Parameters

array $argData

Return Value

$this

in OperationScaffolder at line 216
$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 224
string getName()

Return Value

string

in OperationScaffolder at line 232
ArrayList getArgs()

Return Value

ArrayList

in OperationScaffolder at line 240
string getTypeName()

Return Value

string

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

Parameters

string $arg

Return Value

$this

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

Parameters

array $args

Return Value

$this

in OperationScaffolder at line 270
$this setResolver(callable|ResolverInterface|string $resolver)

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException

in ListQueryScaffolder at line 57
applyConfig(array $config)

Parameters

array $config

Exceptions

Exception

in DataObjectTypeTrait at line 32
string getDataObjectClass()

Return Value

string

in DataObjectTypeTrait at line 40
string typeName()

Return Value

string

in DataObjectTypeTrait at line 48
mixed getDataObjectInstance()

Return Value

mixed

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

Sets the DataObject name

Parameters

string $class

Return Value

$this

in ListQueryScaffolder at line 80
addToManager(Manager $manager)

Parameters

Manager $manager

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

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

Parameters

$bool

Return Value

$this

in ListQueryScaffolder at line 34
$this setUsePagination(bool $bool)

Parameters

bool $bool

Return Value

$this

in ListQueryScaffolder at line 45
$this addSortableFields(array $fields)

Parameters

array $fields

Return Value

$this

in ListQueryScaffolder at line 95
mixed scaffold(Manager $manager)

Parameters

Manager $manager

Return Value

mixed

at line 38
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