update list: add basic filtering and multi sort on the resource's columns

Author: Marius

README.md

@@ -188,7 +188,7 @@ The relations will be retrieved as well when required. The relation keys CAN'T b
 ```pivot``` is optional and appears only on relations that are tied via a pivot.
 
 #### I.3 List filtered resource
-**GET** /{resource}?page=1&limit=10 // filters are available only in the paid version
+**GET** /{resource}?page=1&limit=10&column=2&sort[0][by]=updated_at&sort[0][dir]=ASC // advanced filters and aggregations are available only in the paid version
 
 **GET** /{resource}/{identifier}/{relation}?... // available only in paid version
 
@@ -233,14 +233,16 @@ The reserved words / parameters that will be used as query params are:
         page,
         limit,
         simplePaginate
-        cursor
+        cursor,
+        sort
 
 Defaults:
 
     page=1;
     limit=10;
     simplePaginate is false by default and only its presence is checked in request, not its value
     cursor is not defined
+    sort[dir]=DESC
 
 Obs.
 

src/Models/BaseModel.php

@@ -236,6 +236,18 @@ public function getColumnIndex(string $column, bool $asFirst = false): string
         return $collection->firstOrFail()->Key_name;
     }
 
+    public function getIndexedColumns(bool $includingPrimary = true): array
+    {
+        return $includingPrimary ?
+            $this->retrieveFirstSeqIndexedColumns() :
+            \array_diff($this->retrieveFirstSeqIndexedColumns(), [$this->primaryKey]);
+    }
+
+    public function isIndexRequiredOnFiltering(): bool
+    {
+        return $this->indexRequiredOnFiltering;
+    }
+
     /**
      * @inheritDoc
      */

src/Services/BaseResourceService.php

@@ -80,7 +80,43 @@ public function update(string $identifier, array $request): BaseModel
      */
     public function list(array $request): Builder
     {
-        return $this->model::query();
+        $builder = $this->model::query();
+        $filters = GeneralHelper::filterDataByKeys($request, $possibleSortColumns = $this->model->getColumns());
+
+        if ($this->model->isIndexRequiredOnFiltering()) {
+            $possibleSortColumns = $this->model->getIndexedColumns();
+
+            if (
+                $filters !== []
+                && [] === \array_filter(
+                    GeneralHelper::filterDataByKeys($filters, $possibleSortColumns),
+                    fn (mixed $filter): bool => !\is_array($filter)
+                )
+            ) {
+                throw new \Exception('Ignoring filters');
+            }
+        }
+
+        foreach ($filters as $column => $value) {
+            if (!\is_array($value)) {
+                $builder->where($column, '=', $value);
+            }
+        }
+
+        if ($this->shouldIgnoreSort($possibleSortColumns)) {
+            return $builder;
+        }
+
+        foreach ((array)($request['sort'] ?? []) as $orderBy) {
+            if (\in_array($orderBy['by'] ?? '', $possibleSortColumns, true)) {
+                $builder->orderBy(
+                    $orderBy['by'],
+                    \strtoupper($orderBy['dir'] ?? '') === 'ASC' ? 'ASC' : 'DESC'
+                );
+            }
+        }
+
+        return $builder;
     }
 
     /**
@@ -151,4 +187,15 @@ protected function extractIdentifierConditions(string $identifier): array
             [$this->model->getKeyName(), $identifier]
         ];
     }
+
+    protected function shouldIgnoreSort(array $possibleSortColumns): bool
+    {
+        foreach ($this->request['sort'] ?? [] as $sort) {
+            if (isset($sort['by'])) {
+                return !\in_array($sort['by'], $possibleSortColumns, true);
+            }
+        }
+
+        return true;
+    }
 }