FormSchema
class FormSchema (View source)
Represents a Form as structured data which allows a frontend library to render it.
Includes information about the form as well as its fields. Can create a "schema" (structure only) as well as "state" (data only).
Traits
A class that can be instantiated or replaced via DI
Constants
| PART_SCHEMA |
Request the schema part |
| PART_STATE |
Request the state part |
| PART_ERRORS |
Request the errors from a {ValidationResult} |
| PART_AUTO |
Request errors if invalid, or state if valid |
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.
Returns a representation of the provided Form as structured data, based on the request data.
Return form schema for encoded validation message
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).
array
getMultipartSchema(array|string $schemaParts, string $schemaID, Form $form = null, ValidationResult $result = null)
Returns a representation of the provided Form as structured data, based on the request data.
array
getSchema(Form $form)
Gets the schema for this form as a nested array.
array
getState(Form $form)
Gets the current state of this form as a nested array.
array
getErrors(ValidationResult $result)
No description
protected array
getSchemaForMessage(array $message)
Return form schema for encoded validation message
protected
getFieldStates(FormField> $fields)
No description