mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-08-28 13:36:12 +02:00
From: Sam Minnee <sam@silverstripe.com> git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@90071 467b73ca-7a2a-4603-9d3b-597d59a354a9
192 lines
5.6 KiB
PHP
Executable File
192 lines
5.6 KiB
PHP
Executable File
<?php
|
|
/**
|
|
*
|
|
* @package sapphire
|
|
* @subpackage forms
|
|
*
|
|
* @uses DBField::scaffoldFormField()
|
|
* @uses DataObject::fieldLabels()
|
|
*/
|
|
class FormScaffolder extends Object {
|
|
|
|
/**
|
|
* @var DataObject $obj The object defining the fields to be scaffolded
|
|
* through its metadata like $db, $searchable_fields, etc.
|
|
*/
|
|
protected $obj;
|
|
|
|
/**
|
|
* @var boolean $tabbed Return fields in a tabset, with all main fields in the path "Root.Main",
|
|
* relation fields in "Root.<relationname>" (if {@link $includeRelations} is enabled).
|
|
*/
|
|
public $tabbed = false;
|
|
|
|
/**
|
|
* @var boolean $ajaxSafe
|
|
*/
|
|
public $ajaxSafe = false;
|
|
|
|
/**
|
|
* @var array $restrictFields Numeric array of a field name whitelist.
|
|
* If left blank, all fields from {@link DataObject->db()} will be included.
|
|
*
|
|
* @todo Implement restrictions for has_many and many_many relations.
|
|
*/
|
|
public $restrictFields;
|
|
|
|
/**
|
|
* @var array $fieldClasses Optional mapping of fieldnames to subclasses of {@link FormField}.
|
|
* By default the scaffolder will determine the field instance by {@link DBField::scaffoldFormField()}.
|
|
*
|
|
* @todo Implement fieldClasses for has_many and many_many relations
|
|
*/
|
|
public $fieldClasses;
|
|
|
|
/**
|
|
* @var boolean $includeRelations Include has_one, has_many and many_many relations
|
|
*/
|
|
public $includeRelations = false;
|
|
|
|
/**
|
|
* @param DataObject $obj
|
|
* @param array $params
|
|
*/
|
|
function __construct($obj) {
|
|
$this->obj = $obj;
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* Gets the form fields as defined through the metadata
|
|
* on {@link $obj} and the custom parameters passed to FormScaffolder.
|
|
* Depending on those parameters, the fields can be used in ajax-context,
|
|
* contain {@link TabSet}s etc.
|
|
*
|
|
* @return FieldSet
|
|
*/
|
|
public function getFieldSet() {
|
|
$fields = new FieldSet();
|
|
|
|
// tabbed or untabbed
|
|
if($this->tabbed) {
|
|
$fields->push(new TabSet("Root", $mainTab = new Tab("Main")));
|
|
$mainTab->setTitle(_t('SiteTree.TABMAIN', "Main"));
|
|
}
|
|
|
|
// add database fields
|
|
foreach($this->obj->db() as $fieldName => $fieldType) {
|
|
if($this->restrictFields && !in_array($fieldName, $this->restrictFields)) continue;
|
|
|
|
// @todo Pass localized title
|
|
if($this->fieldClasses && isset($this->fieldClasses[$fieldName])) {
|
|
$fieldClass = $this->fieldClasses[$fieldName];
|
|
$fieldObject = new $fieldClass($fieldName);
|
|
} else {
|
|
$fieldObject = $this->obj->dbObject($fieldName)->scaffoldFormField(null, $this->getParamsArray());
|
|
}
|
|
$fieldObject->setTitle($this->obj->fieldLabel($fieldName));
|
|
if($this->tabbed) {
|
|
$fields->addFieldToTab("Root.Main", $fieldObject);
|
|
} else {
|
|
$fields->push($fieldObject);
|
|
}
|
|
}
|
|
|
|
// add has_one relation fields
|
|
if($this->obj->has_one()) {
|
|
foreach($this->obj->has_one() as $relationship => $component) {
|
|
if($this->restrictFields && !in_array($relationship, $this->restrictFields)) continue;
|
|
$hasOneField = $this->obj->dbObject("{$relationship}ID")->scaffoldFormField(null, $this->getParamsArray());
|
|
$hasOneField->setTitle($this->obj->fieldLabel($relationship));
|
|
if($this->tabbed) {
|
|
$fields->addFieldToTab("Root.Main", $hasOneField);
|
|
} else {
|
|
$fields->push($hasOneField);
|
|
}
|
|
}
|
|
}
|
|
|
|
// only add relational fields if an ID is present
|
|
if($this->obj->ID) {
|
|
// add has_many relation fields
|
|
if($this->obj->has_many() && ($this->includeRelations === true || isset($this->includeRelations['has_many']))) {
|
|
foreach($this->obj->has_many() as $relationship => $component) {
|
|
if($this->tabbed) {
|
|
$relationTab = $fields->findOrMakeTab(
|
|
"Root.$relationship",
|
|
$this->obj->fieldLabel($relationship)
|
|
);
|
|
}
|
|
$relationshipFields = singleton($component)->summaryFields();
|
|
$foreignKey = $this->obj->getRemoteJoinField($relationship);
|
|
$ctf = new ComplexTableField(
|
|
$this,
|
|
$relationship,
|
|
$component,
|
|
$relationshipFields,
|
|
"getCMSFields",
|
|
"$foreignKey = " . $this->obj->ID
|
|
);
|
|
$ctf->setPermissions(TableListField::permissions_for_object($component));
|
|
if($this->tabbed) {
|
|
$fields->addFieldToTab("Root.$relationship", $ctf);
|
|
} else {
|
|
$fields->push($ctf);
|
|
}
|
|
}
|
|
}
|
|
|
|
if($this->obj->many_many() && ($this->includeRelations === true || isset($this->includeRelations['many_many']))) {
|
|
foreach($this->obj->many_many() as $relationship => $component) {
|
|
if($this->tabbed) {
|
|
$relationTab = $fields->findOrMakeTab(
|
|
"Root.$relationship",
|
|
$this->obj->fieldLabel($relationship)
|
|
);
|
|
}
|
|
|
|
$relationshipFields = singleton($component)->summaryFields();
|
|
$filterWhere = $this->obj->getManyManyFilter($relationship, $component);
|
|
$filterJoin = $this->obj->getManyManyJoin($relationship, $component);
|
|
$ctf = new ComplexTableField(
|
|
$this,
|
|
$relationship,
|
|
$component,
|
|
$relationshipFields,
|
|
"getCMSFields",
|
|
$filterWhere,
|
|
'',
|
|
$filterJoin
|
|
);
|
|
$ctf->setPermissions(TableListField::permissions_for_object($component));
|
|
$ctf->popupClass = "ScaffoldingComplexTableField_Popup";
|
|
if($this->tabbed) {
|
|
$fields->addFieldToTab("Root.$relationship", $ctf);
|
|
} else {
|
|
$fields->push($ctf);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $fields;
|
|
}
|
|
|
|
/**
|
|
* Return an array suitable for passing on to {@link DBField->scaffoldFormField()}
|
|
* without tying this call to a FormScaffolder interface.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getParamsArray() {
|
|
return array(
|
|
'tabbed' => $this->tabbed,
|
|
'includeRelations' => $this->includeRelations,
|
|
'restrictFields' => $this->restrictFields,
|
|
'fieldClasses' => $this->fieldClasses,
|
|
'ajaxSafe' => $this->ajaxSafe
|
|
);
|
|
}
|
|
|
|
}
|
|
?>
|