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

Adds schemaDataType to FormFieldSchema

Browse Source
This commit is contained in:
David Craig 2016-03-08 11:54:16 +13:00 committed by Ingo Schommer
parent 1bcd755120
commit 5d88950735
1 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
forms/FormFieldSchemaTrait.php
View File

@ -2,6 +2,8 @@
namespace SilverStripe\Forms\Schema; namespace SilverStripe\Forms\Schema;
use Exception;
/** /**
* Class FormFieldSchemaTrait * Class FormFieldSchemaTrait
* @package SilverStripe\Forms\Schema * @package SilverStripe\Forms\Schema
@ -15,6 +17,34 @@ namespace SilverStripe\Forms\Schema;
*/ */
trait FormFieldSchemaTrait { trait FormFieldSchemaTrait {
/**
* The data type backing the field. Represents the type of value the
* form expects to receive via a postback.
*
* The values allowed in this list include:
*
* - String: Single line text
* - Hidden: Hidden field which is posted back without modification
* - Text: Multi line text
* - HTML: Rich html text
* - Integer: Whole number value
* - Decimal: Decimal value
* - MultiSelect: Select many from source
* - SingleSelect: Select one from source
* - Date: Date only
* - DateTime: Date and time
* - Time: Time only
* - Boolean: Yes or no
* - Custom: Custom type declared by the front-end component. For fields with this type,
* the component property is mandatory, and will determine the posted value for this field.
* - Structural: Represents a field that is NOT posted back. This may contain other fields,
* or simply be a block of stand-alone content. As with 'Custom',
* the component property is mandatory if this is assigned.
*
* @var string
*/
protected $schemaDataType;
/** /**
* The type of front-end component to render the FormField as. * The type of front-end component to render the FormField as.
* *
@ -85,6 +115,14 @@ trait FormFieldSchemaTrait {
return array_merge($this->getSchemaDataDefaults(), $this->schemaData); return array_merge($this->getSchemaDataDefaults(), $this->schemaData);
} }
public function getSchemaDataType() {
if ($this->schemaDataType == null) {
throw new Exception('You need to set a schemaDataType on ' . $this->getName() . ' field');
}
return $this->schemaDataType;
}
/** /**
* Gets the defaults for $schemaData. * Gets the defaults for $schemaData.
* The keys defined here are immutable, meaning undefined keys passed to {@link setSchemaData()} are ignored. * The keys defined here are immutable, meaning undefined keys passed to {@link setSchemaData()} are ignored.
@ -94,7 +132,7 @@ trait FormFieldSchemaTrait {
*/ */
public function getSchemaDataDefaults() { public function getSchemaDataDefaults() {
return [ return [
'type' => $this->class, 'type' => $this->getSchemaDataType(),
'component' => $this->getSchemaComponent(), 'component' => $this->getSchemaComponent(),
'id' => $this->ID, 'id' => $this->ID,
'holder_id' => null, 'holder_id' => null,