Skip to content

Commit

Permalink
TODO: Break this out into appropriate PRs for CMS 5 vs CMS 6
Browse files Browse the repository at this point in the history
  • Loading branch information
@GuySartorelli
GuySartorelli committed Aug 11, 2024
1 parent 370762a commit 9ee0b8c
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 31 deletions.
78 changes: 60 additions & 18 deletions src/Forms/FormScaffolder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,38 +17,55 @@ class FormScaffolder
use Injectable;

/**
* @var DataObject $obj The object defining the fields to be scaffolded
* The object defining the fields to be scaffolded
* through its metadata like $db, $searchable_fields, etc.
*/
protected $obj;
protected DataObject $obj;

/**
* @var boolean $tabbed Return fields in a tabset, with all main fields in the path "Root.Main",
* 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;
public bool $tabbed = false;

/**
* @var boolean $ajaxSafe
* Only set up the "Root.Main" tab, but skip scaffolding actual FormFields.
* If $tabbed is false, an empty FieldList will be returned.
*/
public $ajaxSafe = false;
public bool $tabsOnly = false;

/**
* @var array $restrictFields Numeric array of a field name whitelist.
* If left blank, all fields from {@link DataObject->db()} will be included.
* Array of field names to use as an allow list.
* If left blank, all fields from {@link DataObject->db()} will be included unless explicitly ignored.
*/
public $restrictFields;
public array $restrictFields = [];

/**
* @var array $fieldClasses Optional mapping of fieldnames to subclasses of {@link FormField}.
* Numeric array of field names and has_one relations to explicitly not scaffold.
*/
public array $ignoreFields = [];

/**
* Optional mapping of fieldnames to subclasses of {@link FormField}.
* By default the scaffolder will determine the field instance by {@link DBField::scaffoldFormField()}.
*/
public $fieldClasses;
public array $fieldClasses = [];

/**
* Include has_many and many_many relations
*/
public bool|array $includeRelations = false;

/**
* @var boolean $includeRelations Include has_one, has_many and many_many relations
* Array of relation names to use as an allow list.
* If left blank, all has_many and many_many relations will be scaffolded unless explicitly ignored.
*/
public $includeRelations = false;
public array $restrictRelations = [];

/**
* Numeric array of has_many and many_many relations to explicitly not scaffold.
*/
public array $ignoreRelations = [];

/**
* @param DataObject $obj
Expand Down Expand Up @@ -76,14 +93,21 @@ public function getFieldList()
$mainTab->setTitle(_t(__CLASS__ . '.TABMAIN', 'Main'));
}

if ($this->tabsOnly) {
return $fields;
}

// Add logical fields directly specified in db config
foreach ($this->obj->config()->get('db') as $fieldName => $fieldType) {
// Skip restricted fields
if ($this->restrictFields && !in_array($fieldName, $this->restrictFields ?? [])) {
if (!empty($this->restrictFields) && !in_array($fieldName, $this->restrictFields)) {
continue;
}
if (in_array($fieldName, $this->ignoreFields)) {
continue;
}

if ($this->fieldClasses && isset($this->fieldClasses[$fieldName])) {
if (isset($this->fieldClasses[$fieldName])) {
$fieldClass = $this->fieldClasses[$fieldName];
$fieldObject = new $fieldClass($fieldName);
} else {
Expand All @@ -107,13 +131,16 @@ public function getFieldList()
// add has_one relation fields
if ($this->obj->hasOne()) {
foreach ($this->obj->hasOne() as $relationship => $component) {
if ($this->restrictFields && !in_array($relationship, $this->restrictFields ?? [])) {
if (!empty($this->restrictFields) && !in_array($relationship, $this->restrictFields)) {
continue;
}
if (in_array($relationship, $this->ignoreFields)) {
continue;
}
$fieldName = $component === 'SilverStripe\\ORM\\DataObject'
? $relationship // Polymorphic has_one field is composite, so don't refer to ID subfield
: "{$relationship}ID";
if ($this->fieldClasses && isset($this->fieldClasses[$fieldName])) {
if (isset($this->fieldClasses[$fieldName])) {
$fieldClass = $this->fieldClasses[$fieldName];
$hasOneField = new $fieldClass($fieldName);
} else {
Expand All @@ -138,6 +165,12 @@ public function getFieldList()
&& ($this->includeRelations === true || isset($this->includeRelations['has_many']))
) {
foreach ($this->obj->hasMany() as $relationship => $component) {
if (!empty($this->restrictRelations) && !in_array($relationship, $this->restrictRelations)) {
continue;
}
if (in_array($relationship, $this->ignoreRelations)) {
continue;
}
$includeInOwnTab = true;
$fieldLabel = $this->obj->fieldLabel($relationship);
$fieldClass = (isset($this->fieldClasses[$relationship]))
Expand Down Expand Up @@ -177,6 +210,12 @@ public function getFieldList()
&& ($this->includeRelations === true || isset($this->includeRelations['many_many']))
) {
foreach ($this->obj->manyMany() as $relationship => $component) {
if (!empty($this->restrictRelations) && !in_array($relationship, $this->restrictRelations)) {
continue;
}
if (in_array($relationship, $this->ignoreRelations)) {
continue;
}
static::addManyManyRelationshipFields(
$fields,
$relationship,
Expand Down Expand Up @@ -252,10 +291,13 @@ protected function getParamsArray()
{
return [
'tabbed' => $this->tabbed,
'tabsOnly' => $this->tabsOnly,
'includeRelations' => $this->includeRelations,
'restrictRelations' => $this->restrictRelations,
'ignoreRelations' => $this->ignoreRelations,
'restrictFields' => $this->restrictFields,
'ignoreFields' => $this->ignoreFields,
'fieldClasses' => $this->fieldClasses,
'ajaxSafe' => $this->ajaxSafe
];
}
}
7 changes: 6 additions & 1 deletion src/Forms/Tab.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ public function __construct($name, $titleOrField = null, $fields = null)
// Assign name and title (not assigned by parent constructor)
$this->setName($name);
$this->setTitle($title);
$this->setID(Convert::raw2htmlid($name));
}

public function ID()
Expand All @@ -99,6 +98,12 @@ public function setID($id)
return $this;
}

public function setName($name)
{
$this->setID(Convert::raw2htmlid($name));
return parent::setName($name);
}

/**
* Get child fields
*
Expand Down
24 changes: 24 additions & 0 deletions src/Forms/TabSet.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,30 @@ public function insertAfter($insertAfter, $field, $appendIfMissing = true)
return parent::insertAfter($insertAfter, $field, $appendIfMissing);
}

public function changeTabOrder(array $tabNames): static
{
// Build a map of tabs indexed by their name. This will make the 2nd step much easier.
$tabMap = [];
foreach ($this->children as $tab) {
$tabMap[$tab->getName()] = $tab;
}

// Iterate through the ordered list of names, building a new array to be put into $this->items.
// While we're doing this, empty out $tabMap so that we can keep track of leftovers.
// Unrecognised field names are okay; just ignore them
$tabs = [];
foreach ($tabNames as $tabName) {
if (isset($tabMap[$tabName])) {
$tabs[] = $tabMap[$tabName];
unset($tabMap[$tabName]);
}
}

// Add the leftover fields to the end of the list.
$this->setTabs(FieldList::create([...$tabs, ...$tabMap]));
return $this;
}

/**
* Sets an additional default for $schemaData.
* The existing keys are immutable. HideNav is added in this overriding method to ensure it is not ignored by
Expand Down
38 changes: 26 additions & 12 deletions src/ORM/DataObject.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,14 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
*/
private static $table_name = null;

/**
* Settings used by the FormScaffolder that scaffolds fields for getCMSFields()
*/
private static array $scaffold_cmsfields_settings = [
'includeRelations' => true,
'tabbed' => true,
];

/**
* Non-static relationship cache, indexed by component name.
*
Expand Down Expand Up @@ -2387,8 +2395,8 @@ public function scaffoldSearchFields($_params = null)
{
$params = array_merge(
[
'fieldClasses' => false,
'restrictFields' => false
'fieldClasses' => [],
'restrictFields' => []
],
(array)$_params
);
Expand Down Expand Up @@ -2474,20 +2482,26 @@ public function scaffoldFormFields($_params = null)
$params = array_merge(
[
'tabbed' => false,
'tabsOnly' => false,
'includeRelations' => false,
'restrictFields' => false,
'fieldClasses' => false,
'ajaxSafe' => false
'restrictRelations' => [],
'ignoreRelations' => [],
'restrictFields' => [],
'ignoreFields' => [],
'fieldClasses' => [],
],
(array)$_params
);

$fs = FormScaffolder::create($this);
$fs->tabbed = $params['tabbed'];
$fs->tabsOnly = $params['tabsOnly'];
$fs->includeRelations = $params['includeRelations'];
$fs->restrictRelations = $params['restrictRelations'];
$fs->ignoreRelations = $params['ignoreRelations'];
$fs->restrictFields = $params['restrictFields'];
$fs->ignoreFields = $params['ignoreFields'];
$fs->fieldClasses = $params['fieldClasses'];
$fs->ajaxSafe = $params['ajaxSafe'];

$this->extend('updateFormScaffolder', $fs, $this);

Expand Down Expand Up @@ -2605,12 +2619,12 @@ protected function afterUpdateCMSFields(callable $callback)
*/
public function getCMSFields()
{
$tabbedFields = $this->scaffoldFormFields([
// Don't allow has_many/many_many relationship editing before the record is first saved
'includeRelations' => ($this->ID > 0),
'tabbed' => true,
'ajaxSafe' => true
]);
$scaffoldOptions = static::config()->get('scaffold_cmsfields_settings');
// Don't allow has_many/many_many relationship editing before the record is first saved
if (!$this->isInDB()) {
$scaffoldOptions['includeRelations'] = false;
}
$tabbedFields = $this->scaffoldFormFields($scaffoldOptions);

$this->extend('updateCMSFields', $tabbedFields);

Expand Down
17 changes: 17 additions & 0 deletions src/Security/InheritedPermissionsExtension.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,21 @@ class InheritedPermissionsExtension extends DataExtension
'ViewerMembers',
'EditorMembers',
];

/**
* These fields will need to be added manually, since SiteTree wants it in the special settings tab
* and nothing else in code that uses these fields is scaffolded.
*/
private static array $scaffold_cmsfields_settings = [
'ignoreFields' => [
'CanViewType',
'CanEditType',
],
'ignoreRelations' => [
'ViewerGroups',
'EditorGroups',
'ViewerMembers',
'EditorMembers',
],
];
}

0 comments on commit 9ee0b8c

Please sign in to comment.