NEW Make most GridField components work with arbitrary data

silverstripe · Nov 21, 2023 · d7fee75 · d7fee75
1 parent 6691b4b
commit d7fee75
Show file tree

Hide file tree

Showing 19 changed files with 231 additions and 112 deletions.
diff --git a/src/Forms/Form.php b/src/Forms/Form.php
@@ -12,7 +12,6 @@
 use SilverStripe\Control\Session;
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Core\Injector\Injector;
-use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\ORM\FieldType\DBHTMLText;
 use SilverStripe\ORM\ValidationResult;
@@ -136,7 +135,7 @@ class Form extends ViewableData implements HasRequestHandler
     /**
      * Populated by {@link loadDataFrom()}.
      *
-     * @var DataObject|null
+     * @var ViewableData|null
      */
     protected $record;
 
@@ -1223,10 +1222,10 @@ public function sessionFieldError($message, $fieldName, $type = ValidationResult
     }
 
     /**
-     * Returns the DataObject that has given this form its data
+     * Returns the record that has given this form its data
      * through {@link loadDataFrom()}.
      *
-     * @return DataObject
+     * @return ViewableData
      */
     public function getRecord()
     {
@@ -1285,7 +1284,7 @@ public function validationResult()
     const MERGE_AS_SUBMITTED_VALUE  = 0b1000;
 
     /**
-     * Load data from the given DataObject or array.
+     * Load data from the given record or array.
      *
      * It will call $object->MyField to get the value of MyField.
      * If you passed an array, it will call $object[MyField].
@@ -1306,7 +1305,7 @@ public function validationResult()
      * @uses FormField::setSubmittedValue()
      * @uses FormField::setValue()
      *
-     * @param array|DataObject $data
+     * @param array|ViewableData $data
      * @param int $mergeStrategy
      *  For every field, {@link $data} is interrogated whether it contains a relevant property/key, and
      *  what that property/key's value is.
@@ -1351,7 +1350,7 @@ public function loadDataFrom($data, $mergeStrategy = 0, $fieldList = null)
 
         // If an object is passed, save it for historical reference through {@link getRecord()}
         // Also use this to determine if we are loading a submitted form, or loading
-        // from a dataobject
+        // from a record
         $submitted = true;
         if (is_object($data)) {
             $this->record = $data;
@@ -1480,7 +1479,7 @@ public function loadDataFrom($data, $mergeStrategy = 0, $fieldList = null)
      * Save the contents of this form into the given data object.
      * It will make use of setCastedField() to do this.
      *
-     * @param DataObjectInterface $dataObject The object to save data into
+     * @param ViewableData&DataObjectInterface $dataObject The object to save data into
      * @param FieldList $fieldList An optional list of fields to process.  This can be useful when you have a
      * form that has some fields that save to one object, and some that save to another.
      */
@@ -1523,7 +1522,7 @@ public function saveInto(DataObjectInterface $dataObject, $fieldList = null)
      * {@link FieldList->dataFields()}, which filters out
      * any form-specific data like form-actions.
      * Calls {@link FormField->dataValue()} on each field,
-     * which returns a value suitable for insertion into a DataObject
+     * which returns a value suitable for insertion into a record
      * property.
      *
      * @return array

diff --git a/src/Forms/FormField.php b/src/Forms/FormField.php
@@ -8,13 +8,13 @@
 use SilverStripe\Control\RequestHandler;
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Core\Convert;
-use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\ORM\FieldType\DBField;
 use SilverStripe\ORM\FieldType\DBHTMLText;
 use SilverStripe\ORM\ValidationResult;
 use SilverStripe\View\AttributesHTML;
 use SilverStripe\View\SSViewer;
+use SilverStripe\View\ViewableData;
 
 /**
  * Represents a field in a form.
@@ -454,11 +454,11 @@ public function Value()
     }
 
     /**
-     * Method to save this form field into the given {@link DataObject}.
+     * Method to save this form field into the given record.
      *
      * By default, makes use of $this->dataValue()
      *
-     * @param DataObject|DataObjectInterface $record DataObject to save data into
+     * @param ViewableData|DataObjectInterface $record Record to save data into
      */
     public function saveInto(DataObjectInterface $record)
     {
@@ -697,7 +697,7 @@ public function attrValue()
      * or a submitted form value they should override setSubmittedValue() instead.
      *
      * @param mixed $value Either the parent object, or array of source data being loaded
-     * @param array|DataObject $data {@see Form::loadDataFrom}
+     * @param array|ViewableData $data {@see Form::loadDataFrom}
      * @return $this
      */
     public function setValue($value, $data = null)
@@ -712,7 +712,7 @@ public function setValue($value, $data = null)
      * data formats.
      *
      * @param mixed $value
-     * @param array|DataObject $data
+     * @param array|ViewableData $data
      * @return $this
      */
     public function setSubmittedValue($value, $data = null)

diff --git a/src/Forms/GridField/GridField.php b/src/Forms/GridField/GridField.php
@@ -20,11 +20,14 @@
 use SilverStripe\Forms\GridField\FormAction\StateStore;
 use SilverStripe\ORM\ArrayList;
 use SilverStripe\ORM\DataList;
-use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\ORM\FieldType\DBField;
+use SilverStripe\ORM\Filterable;
+use SilverStripe\ORM\Limitable;
+use SilverStripe\ORM\Sortable;
 use SilverStripe\ORM\SS_List;
 use SilverStripe\View\HTML;
+use SilverStripe\View\ViewableData;
 
 /**
  * Displays a {@link SS_List} in a grid format.
@@ -83,12 +86,12 @@ class GridField extends FormField
     /**
      * Data source.
      *
-     * @var SS_List
+     * @var SS_List&Filterable&Sortable&Limitable
      */
     protected $list = null;
 
     /**
-     * Class name of the DataObject that the GridField will display.
+     * Class name of the records that the GridField will display.
      *
      * Defaults to the value of $this->list->dataClass.
      *
@@ -205,7 +208,7 @@ public function setModelClass($modelClassName)
     }
 
     /**
-     * Returns a data class that is a DataObject type that this GridField should look like.
+     * Returns the class name of the record type that this GridField should contain.
      *
      * @return string
      *
@@ -374,7 +377,7 @@ public function getCastedValue($value, $castingDefinition)
     /**
      * Set the data source.
      *
-     * @param SS_List $list
+     * @param SS_List&Filterable&Sortable&Limitable $list
      *
      * @return $this
      */
@@ -388,7 +391,7 @@ public function setList(SS_List $list)
     /**
      * Get the data source.
      *
-     * @return SS_List
+     * @return SS_List&Filterable&Sortable&Limitable
      */
     public function getList()
     {
@@ -398,7 +401,7 @@ public function getList()
     /**
      * Get the data source after applying every {@link GridField_DataManipulator} to it.
      *
-     * @return SS_List
+     * @return SS_List&Filterable&Sortable&Limitable
      */
     public function getManipulatedList()
     {
@@ -461,7 +464,7 @@ private function addStateFromRequest(): void
         if (($request instanceof NullHTTPRequest) && Controller::has_curr()) {
             $request = Controller::curr()->getRequest();
         }
-        
+
         $stateStr = $this->getStateManager()->getStateFromRequest($this, $request);
         if ($stateStr) {
             $oldState = $this->getState(false);
@@ -744,7 +747,7 @@ public function FieldHolder($properties = [])
     /**
      * @param int $total
      * @param int $index
-     * @param DataObject $record
+     * @param ViewableData $record
      * @param array $attributes
      * @param string $content
      *
@@ -762,7 +765,7 @@ protected function newCell($total, $index, $record, $attributes, $content)
     /**
      * @param int $total
      * @param int $index
-     * @param DataObject $record
+     * @param ViewableData $record
      * @param array $attributes
      * @param string $content
      *
@@ -780,7 +783,7 @@ protected function newRow($total, $index, $record, $attributes, $content)
     /**
      * @param int $total
      * @param int $index
-     * @param DataObject $record
+     * @param ViewableData $record
      *
      * @return array
      */
@@ -798,7 +801,7 @@ protected function getRowAttributes($total, $index, $record)
     /**
      * @param int $total
      * @param int $index
-     * @param DataObject $record
+     * @param ViewableData $record
      *
      * @return array
      */
@@ -869,7 +872,7 @@ public function getColumns()
     /**
      * Get the value from a column.
      *
-     * @param DataObject $record
+     * @param ViewableData $record
      * @param string $column
      *
      * @return string
@@ -922,7 +925,7 @@ public function addDataFields($fields)
      * Use of this method ensures that any special rules around the data for this gridfield are
      * followed.
      *
-     * @param DataObject $record
+     * @param ViewableData $record
      * @param string $fieldName
      *
      * @return mixed
@@ -949,7 +952,7 @@ public function getDataFieldValue($record, $fieldName)
     /**
      * Get extra columns attributes used as HTML attributes.
      *
-     * @param DataObject $record
+     * @param ViewableData $record
      * @param string $column
      *
      * @return array

diff --git a/src/Forms/GridField/GridFieldAddNewButton.php b/src/Forms/GridField/GridFieldAddNewButton.php
@@ -2,7 +2,9 @@
 
 namespace SilverStripe\Forms\GridField;
 
+use LogicException;
 use SilverStripe\Control\Controller;
+use SilverStripe\Core\ClassInfo;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\RelationList;
 use SilverStripe\View\ArrayData;
@@ -12,8 +14,7 @@
  * This component provides a button for opening the add new form provided by
  * {@link GridFieldDetailForm}.
  *
- * Only returns a button if {@link DataObject->canCreate()} for this record
- * returns true.
+ * Only returns a button if canCreate() for this record returns true.
  */
 class GridFieldAddNewButton extends AbstractGridFieldComponent implements GridField_HTMLProvider
 {
@@ -36,7 +37,16 @@ public function __construct($targetFragment = 'before')
 
     public function getHTMLFragments($gridField)
     {
-        $singleton = singleton($gridField->getModelClass());
+        $modelClass = $gridField->getModelClass();
+        $singleton = singleton($modelClass);
+
+        if (!$singleton->hasMethod('canCreate')) {
+            throw new LogicException(
+                __CLASS__ . ' cannot be used with models that do not implement canCreate().'
+                . " Remove this component from your GridField or implement canCreate() on $modelClass"
+            );
+        }
+
         $context = [];
         if ($gridField->getList() instanceof RelationList) {
             $record = $gridField->getForm()->getRecord();
@@ -51,7 +61,7 @@ public function getHTMLFragments($gridField)
 
         if (!$this->buttonName) {
             // provide a default button name, can be changed by calling {@link setButtonName()} on this component
-            $objectName = $singleton->i18n_singular_name();
+            $objectName = $singleton->hasMethod('i18n_singular_name') ? $singleton->i18n_singular_name() : ClassInfo::shortName($singleton);
             $this->buttonName = _t('SilverStripe\\Forms\\GridField\\GridField.Add', 'Add {name}', ['name' => $objectName]);
         }
 

diff --git a/src/Forms/GridField/GridFieldDataColumns.php b/src/Forms/GridField/GridFieldDataColumns.php
@@ -4,7 +4,8 @@
 
 use SilverStripe\Core\Convert;
 use InvalidArgumentException;
-use SilverStripe\ORM\DataObject;
+use LogicException;
+use SilverStripe\View\ViewableData;
 
 /**
  * @see GridField
@@ -87,7 +88,15 @@ public function setDisplayFields($fields)
     public function getDisplayFields($gridField)
     {
         if (!$this->displayFields) {
-            return singleton($gridField->getModelClass())->summaryFields();
+            $modelClass = $gridField->getModelClass();
+            $singleton = singleton($modelClass);
+            if (!$singleton->hasMethod('summaryFields')) {
+                throw new LogicException(
+                    'Cannot dynamically determine columns. Pass the column names to setDisplayFields()'
+                    . " or implement a summaryFields() method on $modelClass"
+                );
+            }
+            return $singleton->summaryFields();
         }
         return $this->displayFields;
     }
@@ -146,7 +155,7 @@ public function getFieldFormatting()
      * HTML for the column, content of the <td> element.
      *
      * @param GridField $gridField
-     * @param DataObject $record Record displayed in this row
+     * @param ViewableData $record Record displayed in this row
      * @param string $columnName
      * @return string HTML for the column. Return NULL to skip.
      */
@@ -180,7 +189,7 @@ public function getColumnContent($gridField, $record, $columnName)
      * Attributes for the element containing the content returned by {@link getColumnContent()}.
      *
      * @param  GridField $gridField
-     * @param  DataObject $record displayed in this row
+     * @param  ViewableData $record displayed in this row
      * @param  string $columnName
      * @return array
      */
@@ -216,7 +225,7 @@ public function getColumnMetadata($gridField, $column)
     /**
      * Translate a Object.RelationName.ColumnName $columnName into the value that ColumnName returns
      *
-     * @param DataObject $record
+     * @param ViewableData $record
      * @param string $columnName
      * @return string|null - returns null if it could not found a value
      */
@@ -269,7 +278,7 @@ protected function castValue($gridField, $fieldName, $value)
     /**
      *
      * @param GridField $gridField
-     * @param DataObject $item
+     * @param ViewableData $item
      * @param string $fieldName
      * @param string $value
      * @return string