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

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
__construct(string $fieldName, array $config = [])

No description

public
mixed
applyConfig(array $config)

No description

public
string|null
getName()

No description

public
setName(string $name)

No description

public
getSerialiser()

No description

public
getEncodedSerialiser()

No description

public
setSerialiser(ResolverReference $serialiser)

No description

public
getValueParser()

No description

public
getEncodedValueParser()

No description

public
setValueParser(ResolverReference $valueParser)

No description

public
getLiteralParser()

No description

public
getEncodedLiteralParser()

No description

public
setLiteralParser(ResolverReference $literalParser)

No description

public
void
validate()

No description

public
string
getSignature()

No description

Details

static Injectable create(mixed ...$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::class); $list = SiteTree::get();

Parameters

mixed ...$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 uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

__construct(string $fieldName, array $config = [])

No description

Parameters

string $fieldName
array $config

Exceptions

SchemaBuilderException

mixed applyConfig(array $config)

No description

Parameters

array $config

Return Value

mixed

string|null getName()

No description

Return Value

string|null

Scalar setName(string $name)

No description

Parameters

string $name

Return Value

Scalar

Exceptions

SchemaBuilderException

ResolverReference getSerialiser()

No description

Return Value

ResolverReference

EncodedResolver getEncodedSerialiser()

No description

Return Value

EncodedResolver

Scalar setSerialiser(ResolverReference $serialiser)

No description

Parameters

ResolverReference $serialiser

Return Value

Scalar

ResolverReference getValueParser()

No description

Return Value

ResolverReference

EncodedResolver getEncodedValueParser()

No description

Return Value

EncodedResolver

Scalar setValueParser(ResolverReference $valueParser)

No description

Parameters

ResolverReference $valueParser

Return Value

Scalar

ResolverReference getLiteralParser()

No description

Return Value

ResolverReference

EncodedResolver getEncodedLiteralParser()

No description

Return Value

EncodedResolver

Scalar setLiteralParser(ResolverReference $literalParser)

No description

Parameters

ResolverReference $literalParser

Return Value

Scalar

void validate()

No description

Return Value

void

Exceptions

SchemaBuilderException

string getSignature()

No description

Return Value

string