class CastingService (View source)

This class provides casting functionality to wrap values in the appropriate class (usually a DBField subclass) for use in the view layer.

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
object|null
cast(mixed $data, ModelData|array|null $source = null, string $fieldName = '', bool $strict = false)

Cast a value to the relevant object (usually a DBField instance) for use in the view layer.

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

object|null cast(mixed $data, ModelData|array|null $source = null, string $fieldName = '', bool $strict = false)

Cast a value to the relevant object (usually a DBField instance) for use in the view layer.

Parameters

mixed $data
ModelData|array|null $source

Where the data originates from. This is used both to check for casting helpers and to help set the value in cast DBField instances.

string $fieldName
bool $strict

If true, an object will be returned even if $data is null.

Return Value

object|null