tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

More reuseable FormSchema logic, return on save

Browse Source
This commit is contained in:
Ingo Schommer 2016-03-03 12:03:38 +13:00
parent e1fcc64c41
commit 61a8529d76
3 changed files with 73 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
admin/code/LeftAndMain.php
View File

@ -181,46 +181,75 @@ class LeftAndMain extends Controller implements PermissionProvider {
/**
* Gets a JSON schema representing the current edit form.
*
* WARNING: Experimental API.
*
* @return SS_HTTPResponse
*/
public function schema() {
$req = $this->getRequest();
$res = $this->getResponse();
public function schema($request) {
$response = $this->getResponse();
$formName = $request->param('ID');
if(!$this->hasMethod("get{$formName}")) {
throw new SS_HTTPResponse_Exception(
'Form not found',
400
);
}
if(!$this->hasAction($formName)) {
throw new SS_HTTPResponse_Exception(
'Form not accessible',
401
);
}
$form = $this->{"get{$formName}"}();
$response->addHeader('Content-Type', 'application/json');
$response->setBody(Convert::raw2json($this->getSchemaForForm($form)));
return $response;
}
/**
* Returns a representation of the provided {@link Form} as structured data,
* based on the request data.
*
* @param Form $form
* @return array
*/
protected function getSchemaForForm(Form $form) {
$request = $this->getRequest();
$schemaParts = [];
$return = null;
// Valid values for the "X-Formschema-Request" header are "schema" and "state".
// If either of these values are set they will be stored in the $schemaParst array
// and used to construct the response body.
if ($schemaHeader = $req->getHeader('X-Formschema-Request')) {
if ($schemaHeader = $request->getHeader('X-Formschema-Request')) {
$schemaParts = array_filter(explode(',', $schemaHeader), function($value) {
$validHeaderValues = ['schema', 'state'];
return in_array(trim($value), $validHeaderValues);
});
}
// Make sure it's an AJAX GET request with a valid "X-Formschema-Request" header value.
if (!$req->isGET() || !count($schemaParts)) {
if (!count($schemaParts)) {
throw new SS_HTTPResponse_Exception(
'Invalid request. Check you\'ve set a "X-Formschema-Request" header with "schema" or "state" values.',
400
);
}
$form = $this->getEditForm();
$responseBody = ['id' => $form->getName()];
$return = ['id' => $form->getName()];
if (in_array('schema', $schemaParts)) {
$responseBody['schema'] = $this->schema->getSchema($form);
$return['schema'] = $this->schema->getSchema($form);
}
if (in_array('state', $schemaParts)) {
$responseBody['state'] = $this->schema->getState($form);
$return['state'] = $this->schema->getState($form);
}
$res->addHeader('Content-Type', 'application/json');
$res->setBody(Convert::raw2json($responseBody));
return $res;
return $return;
}
/**
@ -1067,6 +1096,7 @@ class LeftAndMain extends Controller implements PermissionProvider {
* Save handler
*/
public function save($data, $form) {
$request = $this->getRequest();
$className = $this->stat('tree_class');
// Existing or new record?
@ -1087,7 +1117,16 @@ class LeftAndMain extends Controller implements PermissionProvider {
$this->setCurrentPageID($record->ID);
$this->getResponse()->addHeader('X-Status', rawurlencode(_t('LeftAndMain.SAVEDUP', 'Saved.')));
return $this->getResponseNegotiator()->respond($this->getRequest());
if($request->getHeader('X-Formschema-Request')) {
$data = $this->getSchemaForForm($form);
$response = new SS_HTTPResponse(Convert::raw2json($data));
$response->addHeader('Content-Type', 'application/json');
} else {
$response = $this->getResponseNegotiator()->respond($request);
}
return $response;
}
public function delete($data, $form) {

11
forms/FormFieldSchemaTrait.php
View File

@ -2,6 +2,17 @@
namespace SilverStripe\Forms\Schema;
/**
* Class FormFieldSchemaTrait
* @package SilverStripe\Forms\Schema
*
* Allows {@link FormField} to be represented as structured data,
* including both structure (name, id, attributes, etc.) and state (field value).
* Can be used by {@link FormSchema} to represent a form in JSON,
* to be consumed by a front-end application.
*
* WARNING: Experimental API.
*/
trait FormFieldSchemaTrait {
/**

8
forms/FormSchema.php
View File

@ -5,6 +5,14 @@ namespace SilverStripe\Forms\Schema;
use Convert;
use Form;
/**
* Class FormSchema
* @package SilverStripe\Forms\Schema
*
* 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 {
/**