class DataObjectScaffolder implements ManagerMutatorInterface, ScaffolderInterface, ConfigurationApplier (View source)

Scaffolds a DataObjectTypeCreator.

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

Properties

static private array $extensions

An array of extension names and parameters to be applied to this object upon construction.

from  Extensible
static private array $default_fields

Minimum fields that any type will expose. Useful for implicitly created types, e.g. exposing a has_one.

Methods

string
getDataObjectClass()

No description

$this
setDataObjectClass(string $class)

Sets the DataObject name

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, bool $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.

__construct(string $dataObjectClass)

DataObjectScaffold constructor.

string
getTypeName()

Name of graphql type

$this
addFields(array $fieldData)

Adds visible fields, and optional descriptions.

$this
addField(string $field, string $description = null)

No description

$this
addAllFields(bool $includeHasOne = false)

Adds all db fields, and optionally has_one.

$this
addAllFieldsExcept(array|string $exclusions, bool $includeHasOne = false)

Adds fields against a blacklist.

$this
removeField(string $field)

No description

$this
removeFields(array $fields)

No description

getFields()

No description

getOperations()

No description

getNestedQueries()

No description

$this
setFieldDescription(string $field, string $description)

Sets the description to an existing field.

string
getFieldDescription(string $field)

Gets the Description property from a field, given a name

$this
removeOperation(string $identifier)

Removes an operation.

$this
addAllOperations()

Adds all operations that are registered

operation(string $operation)

Find or make an operation.

nestedQuery(string $fieldName, QueryScaffolder $queryScaffolder = null)

Finds or adds a nested query, e.g. has_many/many_many relation, or a query created with a custom scaffolder

array
getDependentClasses()

Gets types for all ancestors of this class that will need to be added.

array
getAncestralClasses() deprecated

Gets the class ancestry back to DataObject.

cloneTo(DataObjectScaffolder $target)

Clones this scaffolder to another class, copying over only valid fields and operations

applyConfig(array $config)

Applies settings from an array, i.e. YAML

mixed
scaffold(Manager $manager)

No description

addToManager(Manager $manager)

Adds the type to the Manager.

Details

string getDataObjectClass()

Return Value

string

DataObject getDataObjectInstance()

Return Value

DataObject

$this setDataObjectClass(string $class)

Sets the DataObject name

Parameters

string $class

Return Value

$this

$this setChainableParent(DataObjectScaffolder|SchemaScaffolder $parent)

Set parent

Parameters

DataObjectScaffolder|SchemaScaffolder $parent

Return Value

$this

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

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

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

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

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

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.

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

static bool has_extension(string $classOrExtension, string $requiredExtension = null, bool $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.

bool $strict

if the extension has to match the required extension and not be a subclass

Return Value

bool

Flag if the extension exists

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

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

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

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

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.

__construct(string $dataObjectClass)

DataObjectScaffold constructor.

Parameters

string $dataObjectClass

string getTypeName()

Name of graphql type

Return Value

string

$this addFields(array $fieldData)

Adds visible fields, and optional descriptions.

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

Parameters

array $fieldData

Return Value

$this

$this addField(string $field, string $description = null)

Parameters

string $field
string $description

Return Value

$this

$this addAllFields(bool $includeHasOne = false)

Adds all db fields, and optionally has_one.

Parameters

bool $includeHasOne

Return Value

$this

$this addAllFieldsExcept(array|string $exclusions, bool $includeHasOne = false)

Adds fields against a blacklist.

Parameters

array|string $exclusions
bool $includeHasOne

Return Value

$this

$this removeField(string $field)

Parameters

string $field

Return Value

$this

$this removeFields(array $fields)

Parameters

array $fields

Return Value

$this

ArrayList getFields()

Return Value

ArrayList

OperationList getOperations()

Return Value

OperationList

OperationList getNestedQueries()

Return Value

OperationList

$this setFieldDescription(string $field, string $description)

Sets the description to an existing field.

Parameters

string $field
string $description

Return Value

$this

string getFieldDescription(string $field)

Gets the Description property from a field, given a name

Parameters

string $field

Return Value

string

Exceptions

Exception

$this removeOperation(string $identifier)

Removes an operation.

Parameters

string $identifier

Return Value

$this

$this addAllOperations()

Adds all operations that are registered

Return Value

$this

OperationScaffolder operation(string $operation)

Find or make an operation.

Parameters

string $operation

Return Value

OperationScaffolder

OperationScaffolder|ListQueryScaffolder nestedQuery(string $fieldName, QueryScaffolder $queryScaffolder = null)

Finds or adds a nested query, e.g. has_many/many_many relation, or a query created with a custom scaffolder

Parameters

string $fieldName
QueryScaffolder $queryScaffolder

Return Value

OperationScaffolder|ListQueryScaffolder

array getDependentClasses()

Gets types for all ancestors of this class that will need to be added.

Return Value

array

array getAncestralClasses() deprecated

deprecated 2.0.0..3.0.0 Use StaticSchema::getAncestry($class) instead

Gets the class ancestry back to DataObject.

Return Value

array

DataObjectScaffolder cloneTo(DataObjectScaffolder $target)

Clones this scaffolder to another class, copying over only valid fields and operations

Parameters

DataObjectScaffolder $target

Return Value

DataObjectScaffolder

applyConfig(array $config)

Applies settings from an array, i.e. YAML

Parameters

array $config

Exceptions

Exception

mixed scaffold(Manager $manager)

Parameters

Manager $manager

Return Value

mixed

addToManager(Manager $manager)

Adds the type to the Manager.

Parameters

Manager $manager