abstract class DBFieldArgs (View source)

Defines a set of arguments that applies to a field that maps to a DBField.

Provides an Enum of options, and a resolver

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
getEnum()

No description

public
void
applyToField(ModelField $field)

No description

public static 
mixed
baseFormatResolver(mixed $obj, array $args)

No description

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

abstract Enum getEnum()

No description

Return Value

Enum

abstract void applyToField(ModelField $field)

No description

Parameters

ModelField $field

Return Value

void

static mixed baseFormatResolver(mixed $obj, array $args)

No description

Parameters

mixed $obj
array $args

Return Value

mixed