Prevent multisort if it is disabled (#195)

yiisoft · Jul 29, 2024 · 0ad195d · 0ad195d
1 parent f32bd33
commit 0ad195d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 8 deletions.
diff --git a/src/BaseListView.php b/src/BaseListView.php
@@ -93,6 +93,7 @@ abstract class BaseListView extends Widget
     protected UrlParameterProviderInterface|null $urlParameterProvider = null;
 
     private bool $ignoreMissingPage = true;
+    protected bool $enableMultiSort = false;
 
     /**
      * @psalm-var PageNotFoundExceptionCallback|null
@@ -174,6 +175,13 @@ final public function urlParameterProvider(?UrlParameterProviderInterface $provi
         return $new;
     }
 
+    final public function enableMultiSort(bool $value = true): self
+    {
+        $new = clone $this;
+        $new->enableMultiSort = $value;
+        return $new;
+    }
+
     /**
      * Renders the data models.
      *
@@ -371,6 +379,9 @@ private function prepareDataReaderByParams(
             $sortObject = $dataReader->getSort();
             if ($sortObject !== null) {
                 $order = OrderHelper::stringToArray($sort);
+                if (!$this->enableMultiSort) {
+                    $order = array_slice($order, 0, 1, true);
+                }
                 $this->prepareOrder($order);
                 $dataReader = $dataReader->withSort($sortObject->withOrder($order));
             }

diff --git a/src/GridView.php b/src/GridView.php
@@ -66,7 +66,6 @@ final class GridView extends BaseListView
     private array $headerCellAttributes = [];
     private array $bodyCellAttributes = [];
 
-    private bool $enableMultiSort = false;
     private bool $keepPageOnSort = false;
     private ?string $sortableHeaderClass = null;
     private string|Stringable $sortableHeaderPrepend = '';
@@ -136,13 +135,6 @@ public function filterErrorsContainerAttributes(array $attributes): self
         return $new;
     }
 
-    public function enableMultiSort(bool $value = true): self
-    {
-        $new = clone $this;
-        $new->enableMultiSort = $value;
-        return $new;
-    }
-
     public function keepPageOnSort(bool $value = true): self
     {
         $new = clone $this;