mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
2b8e14fdff
performReadonlyTransformation and performDisabledTransformation to be consistent and conform with parent FormField. $trans argument is no longer allowed, just uses DisabledTransformation or ReadonlyTransformation instead.
411 lines
11 KiB
PHP
411 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Base class for all fields that contain other fields.
|
|
* Implements sequentialisation - so that when we're saving / loading data, we can populate
|
|
* a tabbed form properly. All of the children are stored in $this->children
|
|
* @package forms
|
|
* @subpackage fields-structural
|
|
*/
|
|
class CompositeField extends FormField {
|
|
|
|
/**
|
|
* @var FieldList
|
|
*/
|
|
protected $children;
|
|
|
|
/**
|
|
* Set to true when this field is a readonly field
|
|
*/
|
|
protected $readonly;
|
|
|
|
/**
|
|
* @var $columnCount int Toggle different css-rendering for multiple columns
|
|
* ("onecolumn", "twocolumns", "threecolumns"). The content is determined
|
|
* by the $children-array, so wrap all items you want to have grouped in a
|
|
* column inside a CompositeField.
|
|
* Caution: Please make sure that this variable actually matches the
|
|
* count of your $children.
|
|
*/
|
|
protected $columnCount = null;
|
|
|
|
/**
|
|
* @var String custom HTML tag to render with, e.g. to produce a <fieldset>.
|
|
*/
|
|
protected $tag = 'div';
|
|
|
|
/**
|
|
* @var String Optional description for this set of fields.
|
|
* If the {@link $tag} property is set to use a 'fieldset', this will be
|
|
* rendered as a <legend> tag, otherwise its a 'title' attribute.
|
|
*/
|
|
protected $legend;
|
|
|
|
public function __construct($children = null) {
|
|
if($children instanceof FieldList) {
|
|
$this->children = $children;
|
|
} elseif(is_array($children)) {
|
|
$this->children = new FieldList($children);
|
|
} else {
|
|
$children = is_array(func_get_args()) ? func_get_args() : array();
|
|
$this->children = new FieldList($children);
|
|
}
|
|
$this->children->setContainerField($this);
|
|
|
|
// Skipping FormField::__construct(), but we have to make sure this
|
|
// doesn't count as a broken constructor
|
|
$this->brokenOnConstruct = false;
|
|
Object::__construct();
|
|
}
|
|
|
|
/**
|
|
* Returns all the sub-fields, suitable for <% control FieldList %>
|
|
*/
|
|
public function FieldList() {
|
|
return $this->children;
|
|
}
|
|
|
|
/**
|
|
* @deprecated 3.0 Please use {@link FieldList()}.
|
|
*/
|
|
public function FieldSet() {
|
|
Deprecation::notice('3.0', 'Use FieldList() instead.');
|
|
return $this->FieldList();
|
|
}
|
|
|
|
public function setID($id) {
|
|
$this->id = $id;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Accessor method for $this->children
|
|
* @return FieldList
|
|
*/
|
|
public function getChildren() {
|
|
return $this->children;
|
|
}
|
|
|
|
/**
|
|
* @param FieldList $children
|
|
*/
|
|
public function setChildren($children) {
|
|
$this->children = $children;
|
|
return $this;
|
|
}
|
|
|
|
/** @param String */
|
|
public function setTag($tag) {
|
|
$this->tag = $tag;
|
|
return $this;
|
|
}
|
|
|
|
/** @return String */
|
|
public function getTag() {
|
|
return $this->tag;
|
|
}
|
|
|
|
/** @param String */
|
|
public function setLegend($legend) {
|
|
$this->legend = $legend;
|
|
return $this;
|
|
}
|
|
|
|
/** @return String */
|
|
public function getLegend() {
|
|
return $this->legend;
|
|
}
|
|
|
|
function extraClasses() {
|
|
$classes = array('field', 'CompositeField', parent::extraClasses());
|
|
if($this->columnCount) $classes[] = 'multicolumn';
|
|
return implode(' ', $classes);
|
|
}
|
|
|
|
function getAttributes() {
|
|
return array_merge(
|
|
parent::getAttributes(),
|
|
array(
|
|
'tabindex' => null,
|
|
'type' => null,
|
|
'value' => null,
|
|
'type' => null,
|
|
'title' => ($this->tag == 'fieldset') ? null : $this->legend
|
|
)
|
|
);
|
|
}
|
|
|
|
public function Field($properties = array()) {
|
|
$content = '';
|
|
|
|
if($this->tag == 'fieldset' && $this->legend) {
|
|
$content .= '<legend>' . $this->legend . '<legend>';
|
|
}
|
|
|
|
$fs = $this->FieldList();
|
|
foreach($fs as $subfield) {
|
|
if($this->columnCount) {
|
|
$className = "column{$this->columnCount}";
|
|
if(!next($fs)) $className .= " lastcolumn";
|
|
$content .= "\n<div class=\"{$className}\">\n" . $subfield->Field() . "\n</div>\n";
|
|
} else if($subfield){
|
|
$content .= "\n" . $subfield->Field() . "\n";
|
|
}
|
|
}
|
|
|
|
return $this->createTag($this->getTag(), $this->getAttributes(), $content);
|
|
}
|
|
|
|
/**
|
|
* Returns the fields nested inside another DIV
|
|
*/
|
|
function FieldHolder($properties = array()) {
|
|
$content = '';
|
|
|
|
if($this->tag == 'fieldset' && $this->legend) {
|
|
$content .= '<legend>' . $this->legend . '<legend>';
|
|
}
|
|
|
|
$fs = $this->FieldList();
|
|
foreach($fs as $subfield) {
|
|
if($this->columnCount) {
|
|
$className = "column{$this->columnCount}";
|
|
if(!next($fs)) $className .= " lastcolumn";
|
|
$content .= "\n<div class=\"{$className}\">\n" . $subfield->FieldHolder() . "\n</div>\n";
|
|
} else if($subfield){
|
|
$content .= "\n" . $subfield->FieldHolder() . "\n";
|
|
}
|
|
}
|
|
|
|
return $this->createTag($this->getTag(), $this->getAttributes(), $content);
|
|
}
|
|
|
|
/**
|
|
* Returns the fields in the restricted field holder inside a DIV.
|
|
*/
|
|
function SmallFieldHolder() {
|
|
$fs = $this->FieldList();
|
|
$tag = $this->getTag();
|
|
$idAtt = isset($this->id) ? " id=\"{$this->id}\"" : '';
|
|
$className = ($this->columnCount) ? "field CompositeField {$this->extraClass()} multicolumn" : "field CompositeField {$this->extraClass()}";
|
|
$content = "<$tag class=\"$className\"$idAtt>";
|
|
|
|
if($this->tag == 'fieldset' && $this->legend) {
|
|
$content .= '<legend>' . $this->legend . '<legend>';
|
|
}
|
|
|
|
foreach($fs as $subfield) {
|
|
if($this->columnCount) {
|
|
$className = "column{$this->columnCount}";
|
|
if(!next($fs)) $className .= " lastcolumn";
|
|
$content .= "<div class=\"{$className}\">" . $subfield->FieldHolder() . "</div>";
|
|
} else if($subfield){
|
|
$content .= $subfield->SmallFieldHolder() . " ";
|
|
}
|
|
}
|
|
$content .= "</$tag>";
|
|
|
|
return $content;
|
|
}
|
|
/**
|
|
* Add all of the non-composite fields contained within this field to the list.
|
|
* Sequentialisation is used when connecting the form to its data source
|
|
*/
|
|
public function collateDataFields(&$list, $saveableOnly = false) {
|
|
foreach($this->children as $field) {
|
|
if(is_object($field)) {
|
|
if($field->isComposite()) $field->collateDataFields($list, $saveableOnly);
|
|
if($saveableOnly) {
|
|
$isIncluded = ($field->hasData() && !$field->isReadonly() && !$field->isDisabled());
|
|
} else {
|
|
$isIncluded = ($field->hasData());
|
|
}
|
|
if($isIncluded) {
|
|
$name = $field->getName();
|
|
if($name) {
|
|
$formName = (isset($this->form)) ? $this->form->FormName() : '(unknown form)';
|
|
if(isset($list[$name])) user_error("collateDataFields() I noticed that a field called '$name' appears twice in your form: '{$formName}'. One is a '{$field->class}' and the other is a '{$list[$name]->class}'", E_USER_ERROR);
|
|
$list[$name] = $field;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function setForm($form) {
|
|
foreach($this->children as $f) if(is_object($f)) $f->setForm($form);
|
|
parent::setForm($form);
|
|
return $this;
|
|
}
|
|
|
|
function setColumnCount($columnCount) {
|
|
$this->columnCount = $columnCount;
|
|
return $this;
|
|
}
|
|
|
|
function isComposite() {
|
|
return true;
|
|
}
|
|
|
|
function hasData() {
|
|
return false;
|
|
}
|
|
|
|
public function fieldByName($name) {
|
|
return $this->children->fieldByName($name);
|
|
}
|
|
/**
|
|
* Add a new child field to the end of the set.
|
|
*/
|
|
public function push(FormField $field) {
|
|
$this->children->push($field);
|
|
}
|
|
|
|
/**
|
|
* @uses FieldList->insertBefore()
|
|
*/
|
|
public function insertBefore($field, $insertBefore) {
|
|
$ret = $this->children->insertBefore($field, $insertBefore);
|
|
$this->sequentialSet = null;
|
|
return $ret;
|
|
}
|
|
|
|
public function insertAfter($field, $insertAfter) {
|
|
$ret = $this->children->insertAfter($field, $insertAfter);
|
|
$this->sequentialSet = null;
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Remove a field from this CompositeField by Name.
|
|
* The field could also be inside a CompositeField.
|
|
*
|
|
* @param string $fieldName The name of the field
|
|
* @param boolean $dataFieldOnly If this is true, then a field will only
|
|
* be removed if it's a data field. Dataless fields, such as tabs, will
|
|
* be left as-is.
|
|
*/
|
|
public function removeByName($fieldName, $dataFieldOnly = false) {
|
|
$this->children->removeByName($fieldName, $dataFieldOnly);
|
|
}
|
|
|
|
public function replaceField($fieldName, $newField) {
|
|
return $this->children->replaceField($fieldName, $newField);
|
|
}
|
|
|
|
function rootFieldSet() {
|
|
if(is_object($this->containerFieldSet)) return $this->containerFieldSet->rootFieldSet();
|
|
else return $this->children;
|
|
}
|
|
|
|
/**
|
|
* Return a readonly version of this field. Keeps the composition but returns readonly
|
|
* versions of all the child {@link FormField} objects.
|
|
*
|
|
* @return CompositeField
|
|
*/
|
|
public function performReadonlyTransformation() {
|
|
$newChildren = new FieldList();
|
|
$clone = clone $this;
|
|
if($clone->getChildren()) foreach($clone->getChildren() as $idx => $child) {
|
|
if(is_object($child)) $child = $child->transform(new ReadonlyTransformation());
|
|
$newChildren->push($child, $idx);
|
|
}
|
|
|
|
$clone->children = $newChildren;
|
|
$clone->readonly = true;
|
|
|
|
return $clone;
|
|
}
|
|
|
|
/**
|
|
* Return a disabled version of this field. Keeps the composition but returns disabled
|
|
* versions of all the child {@link FormField} objects.
|
|
*
|
|
* @return CompositeField
|
|
*/
|
|
public function performDisabledTransformation() {
|
|
$newChildren = new FieldList();
|
|
$clone = clone $this;
|
|
if($clone->getChildren()) foreach($clone->getChildren() as $idx => $child) {
|
|
if(is_object($child)) $child = $child->transform(new DisabledTransformation());
|
|
$newChildren->push($child, $idx);
|
|
}
|
|
|
|
$clone->children = $newChildren;
|
|
$clone->readonly = true;
|
|
|
|
return $clone;
|
|
}
|
|
|
|
function IsReadonly() {
|
|
return $this->readonly;
|
|
}
|
|
|
|
/**
|
|
* Find the numerical position of a field within
|
|
* the children collection. Doesn't work recursively.
|
|
*
|
|
* @param string|FormField
|
|
* @return Position in children collection (first position starts with 0). Returns FALSE if the field can't be found.
|
|
*/
|
|
function fieldPosition($field) {
|
|
if(is_string($field)) $field = $this->fieldByName($field);
|
|
if(!$field) return false;
|
|
|
|
$i = 0;
|
|
foreach($this->children as $child) {
|
|
if($child->getName() == $field->getName()) return $i;
|
|
$i++;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Transform the named field into a readonly feld.
|
|
*
|
|
* @param string|FormField
|
|
*/
|
|
function makeFieldReadonly($field) {
|
|
$fieldName = ($field instanceof FormField) ? $field->getName() : $field;
|
|
|
|
// Iterate on items, looking for the applicable field
|
|
foreach($this->children as $i => $item) {
|
|
if($item->isComposite()) {
|
|
$item->makeFieldReadonly($fieldName);
|
|
} else {
|
|
// Once it's found, use FormField::transform to turn the field into a readonly version of itself.
|
|
if($item->getName() == $fieldName) {
|
|
$this->children->replaceField($fieldName, $item->transform(new ReadonlyTransformation()));
|
|
|
|
// Clear an internal cache
|
|
$this->sequentialSet = null;
|
|
|
|
// A true results indicates that the field was foudn
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
function debug() {
|
|
$result = "$this->class ($this->name) <ul>";
|
|
foreach($this->children as $child) {
|
|
$result .= "<li>" . Debug::text($child) . " </li>";
|
|
}
|
|
$result .= "</ul>";
|
|
return $result;
|
|
}
|
|
|
|
function validate($validator) {
|
|
$valid = true;
|
|
foreach($this->children as $idx => $child){
|
|
$valid = ($child && $child->validate($validator) && $valid);
|
|
}
|
|
return $valid;
|
|
}
|
|
|
|
}
|
|
|