class FormScaffolder (View source)

Traits

A class that can be instantiated or replaced via DI

Properties

bool $tabbed
bool $ajaxSafe
array $restrictFields
array $fieldClasses
bool $includeRelations

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(DataObject $obj)

No description

getFieldList()

Gets the form fields as defined through the metadata on {@link $obj} and the custom parameters passed to FormScaffolder.

static 
addManyManyRelationshipFields(FieldList $fields, string $relationship, mixed $overrideFieldClass, bool $tabbed, DataObject $dataObject)

Adds the default many-many relation fields for the relationship provided.

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::class); $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(DataObject $obj)

Parameters

DataObject $obj

FieldList getFieldList()

Gets the form fields as defined through the metadata on {@link $obj} and the custom parameters passed to FormScaffolder.

Depending on those parameters, the fields can be used in ajax-context, contain {@link TabSet}s etc.

Return Value

FieldList

static addManyManyRelationshipFields(FieldList $fields, string $relationship, mixed $overrideFieldClass, bool $tabbed, DataObject $dataObject)

Adds the default many-many relation fields for the relationship provided.

Parameters

FieldList $fields

Reference to the @FieldList to add fields to.

string $relationship

The relationship identifier.

mixed $overrideFieldClass

Specify the field class to use here or leave as null to use default.

bool $tabbed

Whether this relationship has it's own tab or not.

DataObject $dataObject

The @DataObject that has the relation.