silverstripe-framework/Forms/Schema/FormSchema.php

90 lines
2.1 KiB
PHP
Raw Normal View History

<?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
2016-02-29 01:50:59 +01:00
* @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' => []
];
foreach ($form->Actions() as $action) {
/** @var FormField $action */
$schema['actions'][] = $action->getSchemaData();
}
foreach ($form->Fields() as $field) {
/** @var FormField $field */
$schema['fields'][] = $field->getSchemaData();
}
2016-02-29 01:50:59 +01:00
return $schema;
}
/**
* Gets the current state of this form as a nested array.
*
* @param Form $form
2016-02-29 01:50:59 +01:00
* @return array
*/
public function getState(Form $form) {
2016-02-29 01:50:59 +01:00
$state = [
'id' => $form->FormName(),
2016-02-29 01:50:59 +01:00
'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(),
];
}
2016-02-29 01:50:59 +01:00
return $state;
}
protected function getFieldStates($fields) {
$states = [];
foreach ($fields as $field) {
$states[] = $field->getSchemaState();
if ($field instanceof CompositeField) {
$subFields = $field->FieldList();
array_merge($states, $this->getFieldStates($subFields));
}
}
return $states;
}
}