class TypeReference (View source)

Uniform way of referring to a type as a string. Accepts default value syntax

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(string $typeStr)

No description

Node
toAST()

No description

mixed
getDefaultValue()

No description

bool
isList()

No description

bool
isRequired()

No description

array
getTypeName()

No description

string
getNamedType()

No description

string
getRawType()

No description

bool
isInternal()

No description

static TypeReference
createFromPath(string $name, array $path = [])

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

__construct(string $typeStr)

Parameters

string $typeStr

Node toAST()

Return Value

Node

mixed getDefaultValue()

Return Value

mixed

bool isList()

Return Value

bool

bool isRequired()

Return Value

bool

array getTypeName()

Return Value

array

string getNamedType()

Return Value

string

string getRawType()

Return Value

string

bool isInternal()

Return Value

bool

static TypeReference createFromPath(string $name, array $path = [])

Parameters

string $name
array $path

Return Value

TypeReference