class ModelConfiguration extends Configuration (View source)

Traits

A class that can be instantiated or replaced via DI

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.

__construct(array $settings = [])

ModelConfiguration constructor.

mixed
get(string|array $path, mixed $default = null)

Return a setting by dot.separated.syntax

set($path, $value)

No description

unset($path)

No description

apply(array $settings)

No description

array
toArray()

No description

callable|null
getTypeFormatter()

No description

string
getTypePrefix()

No description

array
getNestedQueryPlugins()

No description

array
getOperationConfig(string $operation)

No description

string
getTypeName(string $class, array $mapping = [])

No description

array
getDefaultFields()

Fields that are added to the model by default. Can be opted out per type

array
getBaseFields()

Fields that will appear on all models. Cannot be opted out on any type.

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

__construct(array $settings = [])

ModelConfiguration constructor.

Parameters

array $settings

mixed get(string|array $path, mixed $default = null)

Return a setting by dot.separated.syntax

Parameters

string|array $path
mixed $default

Return Value

mixed

Exceptions

SchemaBuilderException

Configuration set($path, $value)

Parameters

$path
$value

Return Value

Configuration

Exceptions

SchemaBuilderException

Configuration unset($path)

Parameters

$path

Return Value

Configuration

Exceptions

SchemaBuilderException

Configuration apply(array $settings)

Parameters

array $settings

Return Value

Configuration

array toArray()

Return Value

array

callable|null getTypeFormatter()

Return Value

callable|null

Exceptions

SchemaBuilderException

string getTypePrefix()

Return Value

string

Exceptions

SchemaBuilderException

array getNestedQueryPlugins()

Return Value

array

Exceptions

SchemaBuilderException

array getOperationConfig(string $operation)

Parameters

string $operation

Return Value

array

Exceptions

SchemaBuilderException

string getTypeName(string $class, array $mapping = [])

Parameters

string $class
array $mapping

Return Value

string

Exceptions

SchemaBuilderException

array getDefaultFields()

Fields that are added to the model by default. Can be opted out per type

Return Value

array

Exceptions

SchemaBuilderException

array getBaseFields()

Fields that will appear on all models. Cannot be opted out on any type.

Return Value

array

Exceptions

SchemaBuilderException