FormScaffolder
class FormScaffolder (View source)
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | DataObject | $obj | ||
| public | bool | $tabbed | ||
| public | bool | $mainTabOnly | Only set up the "Root.Main" tab, but skip scaffolding actual FormFields. |
|
| public deprecated | bool | $ajaxSafe | ||
| public | array | $restrictFields | ||
| public | array | $ignoreFields | Numeric array of field names and has_one relations to explicitly not scaffold. |
|
| public | array | $fieldClasses | ||
| public | bool | $includeRelations | ||
| public | array | $restrictRelations | Array of relation names to use as an allow list. |
|
| public | array | $ignoreRelations | Numeric array of has_many and many_many relations to explicitly not scaffold. |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Gets the form fields as defined through the metadata on $obj and the custom parameters passed to FormScaffolder.
Adds the default many-many relation fields for the relationship provided.
Return an array suitable for passing on to DBField->scaffoldFormField() without tying this call to a FormScaffolder interface.
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();
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).
__construct(DataObject $obj)
No description
FieldList
getFieldList()
Gets the form fields as defined through the metadata on $obj and the custom parameters passed to FormScaffolder.
Depending on those parameters, the fields can be used in ajax-context, contain TabSets etc.
static
addManyManyRelationshipFields(FieldList $fields, string $relationship, string|null $overrideFieldClass, bool $tabbed, DataObject $dataObject)
Adds the default many-many relation fields for the relationship provided.
protected array
getParamsArray()
Return an array suitable for passing on to DBField->scaffoldFormField() without tying this call to a FormScaffolder interface.