class LinkTypeService (View source)

This service class helps to obtain a list of all available Link subclasses, an instance of the Link subclass by key, or a key by class name.

Traits

A class that can be instantiated or replaced via DI

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
array
generateAllLinkTypes()

Generate all link types that are subclasses of Link::class

public
Link|null
byKey(string $key)

Return a Link instance by key

public
string|null
keyByClassName(string $classname)

Return a key for link type by classname

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

array generateAllLinkTypes()

Generate all link types that are subclasses of Link::class

Return Value

array

Link|null byKey(string $key)

Return a Link instance by key

Parameters

string $key

Return Value

Link|null

Exceptions

InvalidArgumentException

string|null keyByClassName(string $classname)

Return a key for link type by classname

Parameters

string $classname

Return Value

string|null

Exceptions

InvalidArgumentException