class ElementTypeRegistry (View source)

Traits

A class that can be instantiated or replaced via DI

Constants

CACHE_KEY

Properties

protected array $elementTypes
protected static CacheInterface $cache

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
$this
registerElement(string $elementClass)

Register an element type with this registry

public
array
getDefinitions()

Get the schema of the element types that are registered

public
mixed
getDefinition($instanceOrClass)

Get the element type data for the given instance or class name of an element.

public static 
generate()

Create a registry and attempt to fill it by resolving element types by introspecting class hierarchy

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

$this registerElement(string $elementClass)

Register an element type with this registry

Parameters

string $elementClass

Return Value

$this

Exceptions

SchemaBuilderException

array getDefinitions()

Get the schema of the element types that are registered

Return Value

array

mixed getDefinition($instanceOrClass)

Get the element type data for the given instance or class name of an element.

Parameters

$instanceOrClass

Return Value

mixed

static ElementTypeRegistry generate()

Create a registry and attempt to fill it by resolving element types by introspecting class hierarchy

Return Value

ElementTypeRegistry