silverstripe-framework/Forms/Schema/FormSchema.php
Christopher Joe ee5b4fd8d3 Tabs support in new file/image editor
Introducing <Tabs> component based on react-bootstrap
Better support for nested fields in FormBuilder
Tweaks to get FormBuilder working with frameworktest BasicFieldsPage fields
Added exception in FormBuilder when Component is defined but not found
Added check in SingleSelectField for empty value before adding one in
Added temporary workaround for CompositeFields with no name (another story to address the actual problem)
Added asset_preview_height for File image preview, matches the defined CSS max-height
Added documentation to DBFile::PreviewLink() method
2016-09-14 14:08:59 +12:00

90 lines
2.1 KiB
PHP

<?php
namespace SilverStripe\Forms\Schema;
use SilverStripe\Forms\CompositeField;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormField;
/**
* Represents a {@link 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).
*/
class FormSchema {
/**
* Gets the schema for this form as a nested array.
*
* @param Form $form
* @return array
*/
public function getSchema(Form $form) {
$request = $form->getController()->getRequest();
$schema = [
'name' => $form->getName(),
'id' => $form->FormName(),
'action' => $form->FormAction(),
'method' => $form->FormMethod(),
// @todo Not really reliable. Refactor into action on $this->Link('schema')
'schema_url' => $request->getURL(),
'attributes' => $form->getAttributes(),
'data' => [],
'fields' => [],
'actions' => []
];
/** @var FormField $action */
foreach ($form->Actions() as $action) {
$schema['actions'][] = $action->getSchemaData();
}
/** @var FormField $field */
foreach ($form->Fields() as $field) {
$schema['fields'][] = $field->getSchemaData();
}
return $schema;
}
/**
* Gets the current state of this form as a nested array.
*
* @param Form $form
* @return array
*/
public function getState(Form $form) {
$state = [
'id' => $form->FormName(),
'fields' => [],
'messages' => []
];
// flattened nested fields are returned, rather than only top level fields.
$state['fields'] = $this->getFieldStates($form->Fields());
if($form->Message()) {
$state['messages'][] = [
'value' => $form->Message(),
'type' => $form->MessageType(),
];
}
return $state;
}
protected function getFieldStates($fields) {
$states = [];
foreach ($fields as $field) {
$states[] = $field->getSchemaState();
if ($field instanceof CompositeField) {
$subFields = $field->FieldList();
$states = array_merge($states, $this->getFieldStates($subFields));
}
}
return $states;
}
}