class Argument implements ConfigurationApplier, SignatureProvider (View source)

An abstraction of a field argument

Traits

A class that can be instantiated or replaced via DI

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

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

__construct(string $name, array $config)

Argument constructor.

mixed
applyConfig(array $config)

No description

setType(string|EncodedType $type)

No description

string|null
getType()

No description

string|null
getName()

No description

setName(string $name)

No description

getEncodedType()

No description

bool|int|string|null
getDefaultValue()

No description

setDefaultValue(bool|int|string|null $defaultValue)

No description

string|null
getDescription()

No description

setDescription(string|null $description)

No description

string
getSignature()

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

__construct(string $name, array $config)

Argument constructor.

Parameters

string $name
array $config

Exceptions

SchemaBuilderException

mixed applyConfig(array $config)

Parameters

array $config

Return Value

mixed

Exceptions

SchemaBuilderException

Argument setType(string|EncodedType $type)

Parameters

string|EncodedType $type

Return Value

Argument

Exceptions

SchemaBuilderException

string|null getType()

Return Value

string|null

string|null getName()

Return Value

string|null

Argument setName(string $name)

Parameters

string $name

Return Value

Argument

EncodedType getEncodedType()

Return Value

EncodedType

bool|int|string|null getDefaultValue()

Return Value

bool|int|string|null

Argument setDefaultValue(bool|int|string|null $defaultValue)

Parameters

bool|int|string|null $defaultValue

Return Value

Argument

string|null getDescription()

Return Value

string|null

Argument setDescription(string|null $description)

Parameters

string|null $description

Return Value

Argument

string getSignature()

Return Value

string

Exceptions

SchemaBuilderException