Merge pull request #361 from creative-commoners/pulls/3.5/arrays

FIX Handle arrays in default_sort

Author: GuySartorelli

src/GridFieldOrderableRows.php

@@ -365,6 +365,13 @@ public function getManipulatedData(GridField $grid, SS_List $list)
                 if ($list instanceof DataList) {
                     $classname = $list->dataClass();
                     if ($defaultSort = Config::inst()->get($classname, 'default_sort')) {
+                        if (is_array($defaultSort)) {
+                            $defaultSortArray = [];
+                            foreach ($defaultSort as $column => $direction) {
+                                $defaultSortArray[] = "\"$column\" $direction";
+                            }
+                            $defaultSort = implode(', ', $defaultSortArray);
+                        }
                         // Append the default sort to the end of the sort string
                         // This may result in redundancy... but it seems to work
                         $sortterm .= ($sortterm ? ', ' : '') . $defaultSort;

tests/GridFieldOrderableRowsTest.php

@@ -24,6 +24,7 @@
 use Symbiote\GridFieldExtensions\Tests\Stub\ThroughIntermediary;
 use Symbiote\GridFieldExtensions\Tests\Stub\TitleObject;
 use Symbiote\GridFieldExtensions\Tests\Stub\TitleSortedObject;
+use Symbiote\GridFieldExtensions\Tests\Stub\TitleArraySortedObject;
 use Symbiote\GridFieldExtensions\Tests\Stub\ThroughIntermediaryVersioned;
 
 /**
@@ -53,6 +54,7 @@ class GridFieldOrderableRowsTest extends SapphireTest
         ThroughBelongs::class,
         TitleObject::class,
         TitleSortedObject::class,
+        TitleArraySortedObject::class,
         ThroughDefinerVersioned::class,
         ThroughIntermediaryVersioned::class,
         ThroughBelongsVersioned::class,
@@ -332,6 +334,17 @@ public function testGetManipulatedDataWithDefaultSort()
         $this->assertSame(['B', 'A', 'C'], $sortedList->column('Iden'));
     }
 
+
+    public function testGetManipulatedDataWithDefaultSortArray()
+    {
+        $sortedList = $this->getTitleSortedListForManipuatedData(TitleArraySortedObject::class, [
+            ['Title' => 'X', 'Iden' => 'C', 'OtherSort' => 3],
+            ['Title' => 'Z', 'Iden' => 'A', 'OtherSort' => 2],
+            ['Title' => 'Z', 'Iden' => 'B', 'OtherSort' => 1],
+        ]);
+        $this->assertSame(['C', 'B', 'A'], $sortedList->column('Iden'));
+    }
+
     private function getTitleSortedListForManipuatedData(string $dataClass, array $data): DataList
     {
         $list = new DataList($dataClass);

tests/Stub/TitleArraySortedObject.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Symbiote\GridFieldExtensions\Tests\Stub;
+
+use SilverStripe\Dev\TestOnly;
+use SilverStripe\ORM\DataObject;
+
+class TitleArraySortedObject extends DataObject implements TestOnly
+{
+    private static $db = [
+        'Title' => 'Varchar',
+        'Iden' => 'Varchar',
+        'OtherSort' => 'Int'
+    ];
+
+    private static array $default_sort = [
+        'Title' => 'ASC',
+        'OtherSort' => 'ASC',
+    ];
+
+    private static $table_name = 'TitleArraySortedObject';
+}