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

Abstraction of a union type

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|null $config = null)

No description

mixed
applyConfig(array $config)

No description

string|null
getName()

No description

setName(string $name)

No description

array
getTypes()

No description

setTypes(array $types)

No description

string
getEncodedTypes()

No description

mixed
getTypeResolver()

No description

setTypeResolver(array|string|ResolverReference|null $resolver)

No description

string|null
getDescription()

No description

setDescription(string|null $description)

No description

mergeWith(UnionType $existing)

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 $name, array|null $config = null)

Parameters

string $name
array|null $config

Exceptions

SchemaBuilderException

mixed applyConfig(array $config)

Parameters

array $config

Return Value

mixed

Exceptions

SchemaBuilderException

string|null getName()

Return Value

string|null

UnionType setName(string $name)

Parameters

string $name

Return Value

UnionType

Exceptions

SchemaBuilderException

array getTypes()

Return Value

array

UnionType setTypes(array $types)

Parameters

array $types

Return Value

UnionType

string getEncodedTypes()

Return Value

string

mixed getTypeResolver()

Return Value

mixed

UnionType setTypeResolver(array|string|ResolverReference|null $resolver)

Parameters

array|string|ResolverReference|null $resolver

Return Value

UnionType

EncodedResolver getEncodedTypeResolver()

Return Value

EncodedResolver

string|null getDescription()

Return Value

string|null

UnionType setDescription(string|null $description)

Parameters

string|null $description

Return Value

UnionType

mergeWith(UnionType $existing)

Parameters

UnionType $existing

Exceptions

SchemaBuilderException

void validate()

Return Value

void

Exceptions

SchemaBuilderException

string getSignature()

Return Value

string