class Scalar implements ConfigurationApplier, SchemaValidator, SignatureProvider, SchemaComponent (View source)

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 $fieldName, array $config = [])

No description

mixed
applyConfig(array $config)

No description

string|null
getName()

No description

setName(string $name)

No description

getSerialiser()

No description

setSerialiser(ResolverReference $serialiser)

No description

setValueParser(ResolverReference $valueParser)

No description

setLiteralParser(ResolverReference $literalParser)

No description

void
validate()

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 $fieldName, array $config = [])

Parameters

string $fieldName
array $config

Exceptions

SchemaBuilderException

mixed applyConfig(array $config)

Parameters

array $config

Return Value

mixed

string|null getName()

Return Value

string|null

Scalar setName(string $name)

Parameters

string $name

Return Value

Scalar

Exceptions

SchemaBuilderException

ResolverReference getSerialiser()

Return Value

ResolverReference

EncodedResolver getEncodedSerialiser()

Return Value

EncodedResolver

Scalar setSerialiser(ResolverReference $serialiser)

Parameters

ResolverReference $serialiser

Return Value

Scalar

ResolverReference getValueParser()

Return Value

ResolverReference

EncodedResolver getEncodedValueParser()

Return Value

EncodedResolver

Scalar setValueParser(ResolverReference $valueParser)

Parameters

ResolverReference $valueParser

Return Value

Scalar

ResolverReference getLiteralParser()

Return Value

ResolverReference

EncodedResolver getEncodedLiteralParser()

Return Value

EncodedResolver

Scalar setLiteralParser(ResolverReference $literalParser)

Parameters

ResolverReference $literalParser

Return Value

Scalar

void validate()

Return Value

void

Exceptions

SchemaBuilderException

string getSignature()

Return Value

string