API Strongly type Fieldlist

This commit is contained in:
Steve Boyd 2024-05-16 18:16:08 +12:00
parent 3c8f8b99e7
commit 7b847f8d7e
6 changed files with 130 additions and 119 deletions

View File

@ -340,7 +340,7 @@ class CompositeField extends FormField
* @param string $insertBefore * @param string $insertBefore
* @param FormField $field * @param FormField $field
* @param bool $appendIfMissing * @param bool $appendIfMissing
* @return false|FormField * @return FormField|null
*/ */
public function insertBefore($insertBefore, $field, $appendIfMissing = true) public function insertBefore($insertBefore, $field, $appendIfMissing = true)
{ {
@ -352,7 +352,7 @@ class CompositeField extends FormField
* @param string $insertAfter * @param string $insertAfter
* @param FormField $field * @param FormField $field
* @param bool $appendIfMissing * @param bool $appendIfMissing
* @return false|FormField * @return FormField|null
*/ */
public function insertAfter($insertAfter, $field, $appendIfMissing = true) public function insertAfter($insertAfter, $field, $appendIfMissing = true)
{ {

View File

@ -2,6 +2,10 @@
namespace SilverStripe\Forms; namespace SilverStripe\Forms;
use InvalidArgumentException;
use RuntimeException;
use SilverStripe\Forms\Tab;
use SilverStripe\Forms\TabSet;
use SilverStripe\ORM\ArrayList; use SilverStripe\ORM\ArrayList;
/** /**
@ -16,24 +20,25 @@ class FieldList extends ArrayList
* Cached flat representation of all fields in this set, * Cached flat representation of all fields in this set,
* including fields nested in {@link CompositeFields}. * including fields nested in {@link CompositeFields}.
* *
* @var FormField[] * @var array<FormField>
*/ */
protected $sequentialSet; protected array $sequentialSet = [];
/** /**
* @var FormField[] * @var array<FormField>
*/ */
protected $sequentialSaveableSet; protected array $sequentialSaveableSet = [];
/** /**
* If this fieldlist is owned by a parent field (e.g. CompositeField) * If this fieldlist is owned by a parent field (e.g. CompositeField)
* this is the parent field. * this is the parent field.
*
* @var CompositeField
*/ */
protected $containerField; protected ?CompositeField $containerField = null;
public function __construct($items = []) /**
* @param array<FormField>|FormField $items Fields Can be given as an array or as a list of arguments
*/
public function __construct(array|FormField $items = [])
{ {
if (!is_array($items) || func_num_args() > 1) { if (!is_array($items) || func_num_args() > 1) {
$items = func_get_args(); $items = func_get_args();
@ -42,13 +47,14 @@ class FieldList extends ArrayList
parent::__construct($items); parent::__construct($items);
foreach ($items as $item) { foreach ($items as $item) {
if ($item instanceof FormField) { if (!is_a($item, FormField::class)) {
throw new InvalidArgumentException('Item is not a FormField, is of class ' . get_class($item));
}
$item->setContainerFieldList($this); $item->setContainerFieldList($this);
} }
} }
}
public function __clone() public function __clone(): void
{ {
// Clone all fields in this list // Clone all fields in this list
foreach ($this->items as $key => $field) { foreach ($this->items as $key => $field) {
@ -58,10 +64,8 @@ class FieldList extends ArrayList
/** /**
* Iterate over each field in the current list recursively * Iterate over each field in the current list recursively
*
* @param callable $callback
*/ */
public function recursiveWalk(callable $callback) public function recursiveWalk(callable $callback): void
{ {
$stack = $this->toArray(); $stack = $this->toArray();
while (!empty($stack)) { while (!empty($stack)) {
@ -75,10 +79,8 @@ class FieldList extends ArrayList
/** /**
* Return a flattened list of all fields * Return a flattened list of all fields
*
* @return static
*/ */
public function flattenFields() public function flattenFields(): static
{ {
$fields = []; $fields = [];
$this->recursiveWalk(function (FormField $field) use (&$fields) { $this->recursiveWalk(function (FormField $field) use (&$fields) {
@ -91,9 +93,9 @@ class FieldList extends ArrayList
* Return a sequential set of all fields that have data. This excludes wrapper composite fields * Return a sequential set of all fields that have data. This excludes wrapper composite fields
* as well as heading / help text fields. * as well as heading / help text fields.
* *
* @return FormField[] * @return array<FormField>
*/ */
public function dataFields() public function dataFields(): array
{ {
if (empty($this->sequentialSet)) { if (empty($this->sequentialSet)) {
$fields = []; $fields = [];
@ -113,9 +115,9 @@ class FieldList extends ArrayList
} }
/** /**
* @return FormField[] * @return array<FormField>
*/ */
public function saveableFields() public function saveableFields(): array
{ {
if (empty($this->sequentialSaveableSet)) { if (empty($this->sequentialSaveableSet)) {
$fields = []; $fields = [];
@ -136,21 +138,16 @@ class FieldList extends ArrayList
/** /**
* Return array of all field names * Return array of all field names
*
* @return array
*/ */
public function dataFieldNames() public function dataFieldNames(): array
{ {
return array_keys($this->dataFields() ?? []); return array_keys($this->dataFields() ?? []);
} }
/** /**
* Trigger an error for duplicate field names * Trigger an error for duplicate field names
*
* @param FormField $field
* @param $functionName
*/ */
protected function fieldNameError(FormField $field, $functionName) protected function fieldNameError(FormField $field, string $functionName): void
{ {
if ($field->getForm()) { if ($field->getForm()) {
$errorSuffix = sprintf( $errorSuffix = sprintf(
@ -170,10 +167,10 @@ class FieldList extends ArrayList
)); ));
} }
protected function flushFieldsCache() protected function flushFieldsCache(): void
{ {
$this->sequentialSet = null; $this->sequentialSet = [];
$this->sequentialSaveableSet = null; $this->sequentialSaveableSet = [];
} }
/** /**
@ -183,11 +180,9 @@ class FieldList extends ArrayList
* @param string $tabName The name of the tab or tabset. Subtabs can be referred to as TabSet.Tab * @param string $tabName The name of the tab or tabset. Subtabs can be referred to as TabSet.Tab
* or TabSet.Tab.Subtab. This function will create any missing tabs. * or TabSet.Tab.Subtab. This function will create any missing tabs.
* @param FormField $field The {@link FormField} object to add to the end of that tab. * @param FormField $field The {@link FormField} object to add to the end of that tab.
* @param string $insertBefore The name of the field to insert before. Optional. * @param string|null $insertBefore The name of the field to insert before.
*
* @return $this
*/ */
public function addFieldToTab($tabName, $field, $insertBefore = null) public function addFieldToTab(string $tabName, FormField $field, ?string $insertBefore = null): static
{ {
// This is a cache that must be flushed // This is a cache that must be flushed
$this->flushFieldsCache(); $this->flushFieldsCache();
@ -211,12 +206,10 @@ class FieldList extends ArrayList
* *
* @param string $tabName The name of the tab or tabset. Subtabs can be referred to as TabSet.Tab * @param string $tabName The name of the tab or tabset. Subtabs can be referred to as TabSet.Tab
* or TabSet.Tab.Subtab. This function will create any missing tabs. * or TabSet.Tab.Subtab. This function will create any missing tabs.
* @param array $fields An array of {@link FormField} objects. * @param array<FormField> $fields An array of {@link FormField} objects.
* @param string $insertBefore Name of field to insert before * @param string|null $insertBefore Name of field to insert before
*
* @return $this
*/ */
public function addFieldsToTab($tabName, $fields, $insertBefore = null) public function addFieldsToTab(string $tabName, array $fields, ?string $insertBefore = null): static
{ {
$this->flushFieldsCache(); $this->flushFieldsCache();
@ -240,14 +233,9 @@ class FieldList extends ArrayList
} }
/** /**
* Remove the given field from the given tab in the field. * Remove the given field from the given tab in the fieldlist.
*
* @param string $tabName The name of the tab
* @param string $fieldName The name of the field
*
* @return $this
*/ */
public function removeFieldFromTab($tabName, $fieldName) public function removeFieldFromTab(string $tabName, string $fieldName): static
{ {
$this->flushFieldsCache(); $this->flushFieldsCache();
@ -264,11 +252,9 @@ class FieldList extends ArrayList
* Removes a number of fields from a Tab/TabSet within this FieldList. * Removes a number of fields from a Tab/TabSet within this FieldList.
* *
* @param string $tabName The name of the Tab or TabSet field * @param string $tabName The name of the Tab or TabSet field
* @param array $fields A list of fields, e.g. array('Name', 'Email') * @param array<string> $fields A list of fields, e.g. array('Name', 'Email')
*
* @return $this
*/ */
public function removeFieldsFromTab($tabName, $fields) public function removeFieldsFromTab(string $tabName, array $fields): static
{ {
$this->flushFieldsCache(); $this->flushFieldsCache();
@ -291,10 +277,8 @@ class FieldList extends ArrayList
* @param boolean $dataFieldOnly If this is true, then a field will only * @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 removed if it's a data field. Dataless fields, such as tabs, will
* be left as-is. * be left as-is.
*
* @return $this
*/ */
public function removeByName($fieldName, $dataFieldOnly = false) public function removeByName(string|array $fieldName, bool $dataFieldOnly = false): static
{ {
if (!$fieldName) { if (!$fieldName) {
user_error('FieldList::removeByName() was called with a blank field name.', E_USER_WARNING); user_error('FieldList::removeByName() was called with a blank field name.', E_USER_WARNING);
@ -336,7 +320,7 @@ class FieldList extends ArrayList
* @return bool TRUE field was successfully replaced * @return bool TRUE field was successfully replaced
* FALSE field wasn't found, nothing changed * FALSE field wasn't found, nothing changed
*/ */
public function replaceField($fieldName, $newField, $dataFieldOnly = true) public function replaceField(string $fieldName, FormField $newField, bool $dataFieldOnly = true): bool
{ {
$this->flushFieldsCache(); $this->flushFieldsCache();
foreach ($this as $i => $field) { foreach ($this as $i => $field) {
@ -357,9 +341,8 @@ class FieldList extends ArrayList
* *
* @param string $fieldName Name of field to rename title of * @param string $fieldName Name of field to rename title of
* @param string $newFieldTitle New title of field * @param string $newFieldTitle New title of field
* @return bool
*/ */
public function renameField($fieldName, $newFieldTitle) public function renameField(string $fieldName, string $newFieldTitle): bool
{ {
$field = $this->dataFieldByName($fieldName); $field = $this->dataFieldByName($fieldName);
if (!$field) { if (!$field) {
@ -371,10 +354,7 @@ class FieldList extends ArrayList
return $field->Title() == $newFieldTitle; return $field->Title() == $newFieldTitle;
} }
/** public function hasTabSet(): bool
* @return bool
*/
public function hasTabSet()
{ {
foreach ($this->items as $i => $field) { foreach ($this->items as $i => $field) {
if (is_object($field) && $field instanceof TabSet) { if (is_object($field) && $field instanceof TabSet) {
@ -389,9 +369,9 @@ class FieldList extends ArrayList
* Returns the specified tab object, if it exists * Returns the specified tab object, if it exists
* *
* @param string $tabName The tab to return, in the form "Tab.Subtab.Subsubtab". * @param string $tabName The tab to return, in the form "Tab.Subtab.Subsubtab".
* @return Tab|null The found or null * @return Tab|TabSet|null The found Tab or TabSet, or null if nothing was found.
*/ */
public function findTab($tabName) public function findTab(string $tabName): Tab|TabSet|null
{ {
$parts = explode('.', $tabName ?? ''); $parts = explode('.', $tabName ?? '');
@ -400,6 +380,7 @@ class FieldList extends ArrayList
foreach ($parts as $k => $part) { foreach ($parts as $k => $part) {
$currentPointer = $currentPointer->fieldByName($part); $currentPointer = $currentPointer->fieldByName($part);
} }
$this->checkIsTabOrTabSetOrNull($tabName, $currentPointer);
return $currentPointer; return $currentPointer;
} }
@ -410,12 +391,12 @@ class FieldList extends ArrayList
* @param string $tabName The tab to return, in the form "Tab.Subtab.Subsubtab". * @param string $tabName The tab to return, in the form "Tab.Subtab.Subsubtab".
* Caution: Does not recursively create TabSet instances, you need to make sure everything * Caution: Does not recursively create TabSet instances, you need to make sure everything
* up until the last tab in the chain exists. * up until the last tab in the chain exists.
* @param string $title Natural language title of the tab. If {@link $tabName} is passed in dot notation, * @param string|null $title Natural language title of the tab. If {@link $tabName} is passed in dot notation,
* the title parameter will only apply to the innermost referenced tab. * the title parameter will only apply to the innermost referenced tab.
* The title is only changed if the tab doesn't exist already. * The title is only changed if the tab doesn't exist already.
* @return Tab The found or newly created Tab instance * @return Tab|TabSet The found or created Tab, or TabSet if "Root" was passed for $tabName
*/ */
public function findOrMakeTab($tabName, $title = null) public function findOrMakeTab(string $tabName, ?string $title = null): Tab|TabSet
{ {
$parts = explode('.', $tabName ?? ''); $parts = explode('.', $tabName ?? '');
$last_idx = count($parts ?? []) - 1; $last_idx = count($parts ?? []) - 1;
@ -447,6 +428,7 @@ class FieldList extends ArrayList
} }
} }
} }
$this->checkIsTabOrTabSetOrNull($tabName, $currentPointer);
return $currentPointer; return $currentPointer;
} }
@ -454,11 +436,8 @@ class FieldList extends ArrayList
/** /**
* Returns a named field. * Returns a named field.
* You can use dot syntax to get fields from child composite fields * You can use dot syntax to get fields from child composite fields
*
* @param string $name
* @return FormField|null
*/ */
public function fieldByName($name) public function fieldByName(string $name): ?FormField
{ {
$fullName = $name; $fullName = $name;
if (strpos($name ?? '', '.') !== false) { if (strpos($name ?? '', '.') !== false) {
@ -493,11 +472,8 @@ class FieldList extends ArrayList
/** /**
* Returns a named field in a sequential set. * Returns a named field in a sequential set.
* Use this if you're using nested FormFields. * Use this if you're using nested FormFields.
*
* @param string $name The name of the field to return
* @return FormField|null
*/ */
public function dataFieldByName($name) public function dataFieldByName(string $name): ?FormField
{ {
if ($dataFields = $this->dataFields()) { if ($dataFields = $this->dataFields()) {
foreach ($dataFields as $child) { foreach ($dataFields as $child) {
@ -513,7 +489,7 @@ class FieldList extends ArrayList
* Inserts a field before a particular field in a FieldList. * Inserts a field before a particular field in a FieldList.
* Will traverse CompositeFields depth-first to find the matching $name, and insert before the first match * Will traverse CompositeFields depth-first to find the matching $name, and insert before the first match
*/ */
public function insertBefore(string $name, FormField $item, bool $appendIfMissing = true): FormField|bool public function insertBefore(string $name, FormField $item, bool $appendIfMissing = true): ?FormField
{ {
$this->onBeforeInsert($item); $this->onBeforeInsert($item);
$item->setContainerFieldList($this); $item->setContainerFieldList($this);
@ -538,14 +514,14 @@ class FieldList extends ArrayList
return $item; return $item;
} }
return false; return null;
} }
/** /**
* Inserts a field after a particular field in a FieldList. * Inserts a field after a particular field in a FieldList.
* Will traverse CompositeFields depth-first to find the matching $name, and insert after the first match * Will traverse CompositeFields depth-first to find the matching $name, and insert after the first match
*/ */
public function insertAfter(string $name, FormField $item, bool $appendIfMissing = true): FormField|bool public function insertAfter(string $name, FormField $item, bool $appendIfMissing = true): ?FormField
{ {
$this->onBeforeInsert($item); $this->onBeforeInsert($item);
$item->setContainerFieldList($this); $item->setContainerFieldList($this);
@ -570,7 +546,7 @@ class FieldList extends ArrayList
return $item; return $item;
} }
return false; return null;
} }
/** /**
@ -616,11 +592,8 @@ class FieldList extends ArrayList
/** /**
* Set the Form instance for this FieldList. * Set the Form instance for this FieldList.
*
* @param Form $form The form to set this FieldList to
* @return $this
*/ */
public function setForm($form) public function setForm(Form $form): static
{ {
foreach ($this as $field) { foreach ($this as $field) {
$field->setForm($form); $field->setForm($form);
@ -633,9 +606,8 @@ class FieldList extends ArrayList
* Load the given data into this form. * Load the given data into this form.
* *
* @param array $data An map of data to load into the FieldList * @param array $data An map of data to load into the FieldList
* @return $this
*/ */
public function setValues($data) public function setValues(array $data): static
{ {
foreach ($this->dataFields() as $field) { foreach ($this->dataFields() as $field) {
$fieldName = $field->getName(); $fieldName = $field->getName();
@ -650,10 +622,8 @@ class FieldList extends ArrayList
* Return all <input type="hidden"> fields * Return all <input type="hidden"> fields
* in a form - including fields nested in {@link CompositeFields}. * in a form - including fields nested in {@link CompositeFields}.
* Useful when doing custom field layouts. * Useful when doing custom field layouts.
*
* @return FieldList
*/ */
public function HiddenFields() public function HiddenFields(): FieldList
{ {
$hiddenFields = new FieldList(); $hiddenFields = new FieldList();
$dataFields = $this->dataFields(); $dataFields = $this->dataFields();
@ -673,7 +643,7 @@ class FieldList extends ArrayList
* Return all fields except for the hidden fields. * Return all fields except for the hidden fields.
* Useful when making your own simplified form layouts. * Useful when making your own simplified form layouts.
*/ */
public function VisibleFields() public function VisibleFields(): FieldList
{ {
$visibleFields = new FieldList(); $visibleFields = new FieldList();
@ -689,11 +659,8 @@ class FieldList extends ArrayList
/** /**
* Transform this FieldList with a given transform method, * Transform this FieldList with a given transform method,
* e.g. $this->transform(new ReadonlyTransformation()) * e.g. $this->transform(new ReadonlyTransformation())
*
* @param FormTransformation $trans
* @return FieldList
*/ */
public function transform($trans) public function transform(FormTransformation $trans): FieldList
{ {
$this->flushFieldsCache(); $this->flushFieldsCache();
$newFields = new FieldList(); $newFields = new FieldList();
@ -705,10 +672,8 @@ class FieldList extends ArrayList
/** /**
* Returns the root field set that this belongs to * Returns the root field set that this belongs to
*
* @return FieldList|FormField
*/ */
public function rootFieldList() public function rootFieldList(): FieldList
{ {
if ($this->containerField) { if ($this->containerField) {
return $this->containerField->rootFieldList(); return $this->containerField->rootFieldList();
@ -717,19 +682,12 @@ class FieldList extends ArrayList
return $this; return $this;
} }
/** public function getContainerField(): ?CompositeField
* @return CompositeField|null
*/
public function getContainerField()
{ {
return $this->containerField; return $this->containerField;
} }
/** public function setContainerField(?CompositeField $field): static
* @param CompositeField|null $field
* @return $this
*/
public function setContainerField($field)
{ {
$this->containerField = $field; $this->containerField = $field;
return $this; return $this;
@ -737,20 +695,16 @@ class FieldList extends ArrayList
/** /**
* Transforms this FieldList instance to readonly. * Transforms this FieldList instance to readonly.
*
* @return FieldList
*/ */
public function makeReadonly() public function makeReadonly(): FieldList
{ {
return $this->transform(new ReadonlyTransformation()); return $this->transform(new ReadonlyTransformation());
} }
/** /**
* Transform the named field into a readonly field. * Transform the named field into a readonly field.
*
* @param string|array|FormField $field
*/ */
public function makeFieldReadonly($field) public function makeFieldReadonly(string|array|FormField $field): void
{ {
if (!is_array($field)) { if (!is_array($field)) {
$field = [$field]; $field = [$field];
@ -774,9 +728,9 @@ class FieldList extends ArrayList
* *
* Please note that any tabs or other dataless fields will be clobbered by this operation. * Please note that any tabs or other dataless fields will be clobbered by this operation.
* *
* @param array $fieldNames Field names can be given as an array, or just as a list of arguments. * @param array<string>|string $fieldNames Field names can be given as an array, or just as a list of arguments.
*/ */
public function changeFieldOrder($fieldNames) public function changeFieldOrder(array|string $fieldNames): void
{ {
// Field names can be given as an array, or just as a list of arguments. // Field names can be given as an array, or just as a list of arguments.
if (!is_array($fieldNames)) { if (!is_array($fieldNames)) {
@ -813,11 +767,10 @@ class FieldList extends ArrayList
* Find the numerical position of a field within * Find the numerical position of a field within
* the children collection. Doesn't work recursively. * the children collection. Doesn't work recursively.
* *
* @param string|FormField $field * @return int|false Position in children collection (first position starts with 0).
* @return int Position in children collection (first position starts with 0).
* Returns FALSE if the field can't be found. * Returns FALSE if the field can't be found.
*/ */
public function fieldPosition($field) public function fieldPosition(string|FormField $field): int|false
{ {
if ($field instanceof FormField) { if ($field instanceof FormField) {
$field = $field->getName(); $field = $field->getName();
@ -837,7 +790,7 @@ class FieldList extends ArrayList
/** /**
* Default template rendering of a FieldList will concatenate all FieldHolder values. * Default template rendering of a FieldList will concatenate all FieldHolder values.
*/ */
public function forTemplate() public function forTemplate(): string
{ {
$output = ""; $output = "";
foreach ($this as $field) { foreach ($this as $field) {
@ -845,4 +798,12 @@ class FieldList extends ArrayList
} }
return $output; return $output;
} }
private function checkIsTabOrTabSetOrNull(string $tabName, mixed $currentPointer): void
{
if ($currentPointer && (!is_a($currentPointer, Tab::class) && !is_a($currentPointer, TabSet::class))) {
$className = get_class($currentPointer);
throw new RuntimeException("$tabName is an instance of '$className', not Tab or TabSet");
}
}
} }

View File

@ -1362,8 +1362,12 @@ class FormField extends RequestHandler
$field = $classOrCopy; $field = $classOrCopy;
if (!is_object($field)) { if (!is_object($field)) {
if (is_a($classOrCopy, CompositeField::class, true)) {
$field = $classOrCopy::create([]);
} else {
$field = $classOrCopy::create($this->name); $field = $classOrCopy::create($this->name);
} }
}
$extraClasses = $this->extraClasses ? array_values($this->extraClasses) : []; $extraClasses = $this->extraClasses ? array_values($this->extraClasses) : [];
$field $field

View File

@ -66,6 +66,9 @@ class Tab extends CompositeField
$title = static::name_to_label($name); $title = static::name_to_label($name);
} }
// Remove any blank strings from fields
$fields = array_filter($fields);
// Remaining arguments are child fields // Remaining arguments are child fields
parent::__construct($fields); parent::__construct($fields);

View File

@ -2,6 +2,9 @@
namespace SilverStripe\Forms\Tests; namespace SilverStripe\Forms\Tests;
use stdClass;
use InvalidArgumentException;
use RuntimeException;
use SilverStripe\Dev\SapphireTest; use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\ConfirmedPasswordField; use SilverStripe\Forms\ConfirmedPasswordField;
use SilverStripe\Forms\FieldList; use SilverStripe\Forms\FieldList;
@ -23,6 +26,13 @@ use SilverStripe\Forms\HiddenField;
*/ */
class FieldListTest extends SapphireTest class FieldListTest extends SapphireTest
{ {
public function testInvalidArrayConstructorArg()
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Item is not a FormField, is of class stdClass');
new FieldList([new stdClass()]);
}
public function testRecursiveWalk() public function testRecursiveWalk()
{ {
$fields = [ $fields = [
@ -259,6 +269,32 @@ class FieldListTest extends SapphireTest
$this->assertNull($fields->findTab('More')); $this->assertNull($fields->findTab('More'));
$this->assertEquals($fields->findTab('Root.More'), $more); $this->assertEquals($fields->findTab('Root.More'), $more);
$this->assertEquals($fields->findTab('Root.More.Tab4'), $tab4); $this->assertEquals($fields->findTab('Root.More.Tab4'), $tab4);
$fields->addFieldToTab('Root.Tab1', new TextField('Field1'));
$this->expectException(RuntimeException::class);
$message = "Root.Tab1.Field1 is an instance of 'SilverStripe\Forms\TextField', not Tab or TabSet";
$this->expectExceptionMessage($message);
$fields->findTab('Root.Tab1.Field1');
}
public function testFindOrMakeTab()
{
$fields = new FieldList(
$root = new TabSet(
'Root',
$tab1 = new Tab('Tab1'),
)
);
$this->assertEquals($fields->findTab('Root'), $root);
$this->assertEquals($fields->findOrMakeTab('Root.Tab1'), $tab1);
$tab2 = $fields->findOrMakeTab('Root.Tab2');
$this->assertEquals(Tab::class, get_class($tab2));
$fields->addFieldToTab('Root.Tab1', new TextField('Field1'));
$this->expectException(RuntimeException::class);
$message = "Root.Tab1.Field1 is an instance of 'SilverStripe\Forms\TextField', not Tab or TabSet";
$this->expectExceptionMessage($message);
$fields->findOrMakeTab('Root.Tab1.Field1');
} }
/** /**

View File

@ -683,4 +683,11 @@ class FormFieldTest extends SapphireTest
$this->assertInstanceOf(Tip::class, $field->getTitleTip()); $this->assertInstanceOf(Tip::class, $field->getTitleTip());
$this->assertSame('Test tip', $field->getTitleTip()->getMessage()); $this->assertSame('Test tip', $field->getTitleTip()->getMessage());
} }
public function testCastedCopy()
{
$field = new FormField('MyField');
$this->assertTrue(is_a($field->castedCopy(TextField::class), TextField::class));
$this->assertTrue(is_a($field->castedCopy(CompositeField::class), CompositeField::class));
}
} }