Merge pull request #11433 from creative-commoners/pulls/6/ss-list-com…

…bine API Combine Sortable, Filterable and Limitable into SS_List
silverstripe · Oct 30, 2024 · 57ae271 · 57ae271
2 parents c1a51aa + f5730a3
commit 57ae271
Show file tree

Hide file tree

Showing 27 changed files with 420 additions and 533 deletions.
diff --git a/src/Forms/GridField/GridField.php b/src/Forms/GridField/GridField.php
@@ -22,9 +22,6 @@
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObjectInterface;
 use SilverStripe\ORM\FieldType\DBField;
-use SilverStripe\Model\List\Filterable;
-use SilverStripe\Model\List\Limitable;
-use SilverStripe\Model\List\Sortable;
 use SilverStripe\Model\List\SS_List;
 use SilverStripe\View\HTML;
 use SilverStripe\Model\ModelData;
@@ -86,7 +83,7 @@ class GridField extends FormField
     /**
      * Data source.
      *
-     * @var SS_List&Filterable&Sortable&Limitable
+     * @var SS_List
      */
     protected $list = null;
 
@@ -397,7 +394,7 @@ public function getCastedValue($value, $castingDefinition)
     /**
      * Set the data source.
      *
-     * @param SS_List&Filterable&Sortable&Limitable $list
+     * @param SS_List $list
      *
      * @return $this
      */
@@ -411,7 +408,7 @@ public function setList(SS_List $list)
     /**
      * Get the data source.
      *
-     * @return SS_List&Filterable&Sortable&Limitable
+     * @return SS_List
      */
     public function getList()
     {
@@ -421,7 +418,7 @@ public function getList()
     /**
      * Get the data source after applying every {@link GridField_DataManipulator} to it.
      *
-     * @return SS_List&Filterable&Sortable&Limitable
+     * @return SS_List
      */
     public function getManipulatedList()
     {

diff --git a/src/Forms/GridField/GridFieldDetailForm_ItemRequest.php b/src/Forms/GridField/GridFieldDetailForm_ItemRequest.php
@@ -810,7 +810,7 @@ protected function saveFormIntoRecord($data, $form)
         $this->extend('onAfterSave', $this->record);
 
         $extraData = $this->getExtraSavedData($this->record, $list);
-        $list->add($this->record, $extraData);
+        $list->add($this->record, $extraData ?: []);
 
         return $this->record;
     }

diff --git a/src/Forms/GridField/GridFieldFilterHeader.php b/src/Forms/GridField/GridFieldFilterHeader.php
@@ -11,7 +11,6 @@
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
 use SilverStripe\Forms\Schema\FormSchema;
-use SilverStripe\Model\List\Filterable;
 use SilverStripe\ORM\Search\SearchContext;
 use SilverStripe\Model\List\SS_List;
 use SilverStripe\Model\ArrayData;
@@ -109,13 +108,13 @@ public function setSearchField(string $field): GridFieldFilterHeader
      */
     protected function checkDataType($dataList)
     {
-        if ($dataList instanceof Filterable) {
+        if ($dataList instanceof SS_List) {
             return true;
         } else {
             // This will be changed to always throw an exception in a future major release.
             if ($this->throwExceptionOnBadDataType) {
                 throw new LogicException(
-                    static::class . " expects an SS_Filterable list to be passed to the GridField."
+                    static::class . " expects an SS_List list to be passed to the GridField."
                 );
             }
             return false;
@@ -209,7 +208,7 @@ public function getManipulatedData(GridField $gridField, SS_List $dataList)
     public function canFilterAnyColumns($gridField)
     {
         $list = $gridField->getList();
-        if (!($list instanceof Filterable) || !$this->checkDataType($list)) {
+        if (!($list instanceof SS_List) || !$this->checkDataType($list)) {
             return false;
         }
         $modelClass = $gridField->getModelClass();

diff --git a/src/Forms/GridField/GridFieldLazyLoader.php b/src/Forms/GridField/GridFieldLazyLoader.php
@@ -5,7 +5,6 @@
 use SilverStripe\Forms\FormField;
 use SilverStripe\Forms\TabSet;
 use SilverStripe\Model\List\ArrayList;
-use SilverStripe\Model\List\Filterable;
 use SilverStripe\Model\List\SS_List;
 
 /**
@@ -28,7 +27,7 @@ public function getManipulatedData(GridField $gridField, SS_List $dataList)
     {
         // If we are lazy loading an empty the list
         if ($this->isLazy($gridField)) {
-            if ($dataList instanceof Filterable) {
+            if ($dataList instanceof SS_List) {
                 // If our original list can be filtered, filter out all results.
                 $dataList = $dataList->byIDs([-1]);
             } else {

diff --git a/src/Forms/GridField/GridFieldPaginator.php b/src/Forms/GridField/GridFieldPaginator.php
@@ -3,7 +3,6 @@
 namespace SilverStripe\Forms\GridField;
 
 use SilverStripe\Core\Config\Configurable;
-use SilverStripe\Model\List\Limitable;
 use SilverStripe\Model\List\SS_List;
 use SilverStripe\ORM\UnsavedRelationList;
 use SilverStripe\Model\ArrayData;
@@ -89,13 +88,13 @@ public function getThrowExceptionOnBadDataType()
      */
     protected function checkDataType($dataList)
     {
-        if ($dataList instanceof Limitable) {
+        if ($dataList instanceof SS_List) {
             return true;
         } else {
             // This will be changed to always throw an exception in a future major release.
             if ($this->throwExceptionOnBadDataType) {
                 throw new LogicException(
-                    static::class . " expects an SS_Limitable list to be passed to the GridField."
+                    static::class . " expects an SS_List list to be passed to the GridField."
                 );
             }
             return false;
@@ -183,7 +182,7 @@ public function getManipulatedData(GridField $gridField, SS_List $dataList)
             $startRow = 0;
         }
 
-        if (!($dataList instanceof Limitable) || ($dataList instanceof UnsavedRelationList)) {
+        if (!($dataList instanceof SS_List) || ($dataList instanceof UnsavedRelationList)) {
             return $dataList;
         }
 

diff --git a/src/Forms/GridField/GridFieldSortableHeader.php b/src/Forms/GridField/GridFieldSortableHeader.php
@@ -4,7 +4,6 @@
 
 use SilverStripe\Forms\LiteralField;
 use SilverStripe\ORM\DataObjectSchema;
-use SilverStripe\Model\List\Sortable;
 use SilverStripe\Model\List\ArrayList;
 use SilverStripe\Model\List\SS_List;
 use SilverStripe\ORM\DataObject;
@@ -78,13 +77,13 @@ public function getThrowExceptionOnBadDataType()
      */
     protected function checkDataType($dataList)
     {
-        if ($dataList instanceof Sortable) {
+        if ($dataList instanceof SS_List) {
             return true;
         } else {
             // This will be changed to always throw an exception in a future major release.
             if ($this->throwExceptionOnBadDataType) {
                 throw new LogicException(
-                    static::class . " expects an SS_Sortable list to be passed to the GridField."
+                    static::class . " expects an SS_List list to be passed to the GridField."
                 );
             }
             return false;
@@ -246,7 +245,7 @@ public function handleAction(GridField $gridField, $actionName, $arguments, $dat
      * {@link DataQuery} first.
      *
      * @param GridField $gridField
-     * @param SS_List&Sortable $dataList
+     * @param SS_List $dataList
      * @return SS_List
      */
     public function getManipulatedData(GridField $gridField, SS_List $dataList)