Allow paginate with WHERE and ORDER BY clauses

Author: natanfelles

src/Model.php

@@ -469,24 +469,53 @@ protected function sanitizePageNumber(int $number) : int
      *
      * @param mixed $page The current page
      * @param mixed $perPage Items per page
+     * @param array<string>|string $orderBy Order by columns
+     * @param string $orderByDirection asc or desc
+     * @param array<array<mixed>> $where Array in this format: `[['id', '=', 25]]`
+     *
+     * @see Where
      *
      * @return array<int,array<mixed>|Entity|stdClass>
      */
-    public function paginate(mixed $page, mixed $perPage = 10) : array
-    {
+    public function paginate(
+        mixed $page,
+        mixed $perPage = 10,
+        array $where = [],
+        array | string $orderBy = null,
+        string $orderByDirection = 'asc',
+    ) : array {
         $page = Pager::sanitize($page);
         $perPage = Pager::sanitize($perPage);
-        $data = $this->getDatabaseToRead()
+        $select = $this->getDatabaseToRead()
             ->select()
             ->from($this->getTable())
-            ->limit(...$this->makePageLimitAndOffset($page, $perPage))
-            ->run()
-            ->fetchArrayAll();
+            ->limit(...$this->makePageLimitAndOffset($page, $perPage));
+        if ($where) {
+            foreach ($where as $args) {
+                $select->where(...$args);
+            }
+        }
+        if ($orderBy !== null) {
+            $orderBy = (array) $orderBy;
+            $orderByDir = \strtolower($orderByDirection);
+            if ( ! \in_array($orderByDir, [
+                'asc',
+                'desc',
+            ])) {
+                throw new InvalidArgumentException(
+                    'Invalid ORDER BY direction: ' . $orderByDirection
+                );
+            }
+            $orderByDir === 'asc'
+                ? $select->orderByAsc(...$orderBy)
+                : $select->orderByDesc(...$orderBy);
+        }
+        $data = $select->run()->fetchArrayAll();
         foreach ($data as &$row) {
             $row = $this->makeEntity($row);
         }
         unset($row);
-        $this->setPager(new Pager($page, $perPage, $this->count()));
+        $this->setPager(new Pager($page, $perPage, $this->count($where)));
         return $data;
     }
 

tests/ModelTest.php

@@ -408,32 +408,81 @@ public function testCount() : void
 
     public function testPaginatedItems() : void
     {
+        $date = \date('Y-m-d H:i:s');
         $this->model->returnType = 'array';
         self::assertSame([
             [
                 'id' => 1,
                 'data' => 'foo',
-                'createdAt' => \date('Y-m-d H:i:s'),
-                'updatedAt' => \date('Y-m-d H:i:s'),
+                'createdAt' => $date,
+                'updatedAt' => $date,
             ],
         ], $this->model->paginate(-1, 1));
         self::assertSame([
             [
                 'id' => 1,
                 'data' => 'foo',
-                'createdAt' => \date('Y-m-d H:i:s'),
-                'updatedAt' => \date('Y-m-d H:i:s'),
+                'createdAt' => $date,
+                'updatedAt' => $date,
             ],
         ], $this->model->paginate(1, 1));
         self::assertSame([
             [
                 'id' => 2,
                 'data' => 'bar',
-                'createdAt' => \date('Y-m-d H:i:s'),
-                'updatedAt' => \date('Y-m-d H:i:s'),
+                'createdAt' => $date,
+                'updatedAt' => $date,
             ],
         ], $this->model->paginate(2, 1));
         self::assertSame([], $this->model->paginate(3, 1));
+        self::assertSame([
+            [
+                'id' => 2,
+                'data' => 'bar',
+                'createdAt' => $date,
+                'updatedAt' => $date,
+            ],
+        ], $this->model->paginate(1, 10, [
+            ['id', '=', 2],
+            ['id', 'between', 0, 3],
+        ]));
+        self::assertSame([
+            [
+                'id' => 1,
+                'data' => 'foo',
+                'createdAt' => $date,
+                'updatedAt' => $date,
+            ],
+            [
+                'id' => 2,
+                'data' => 'bar',
+                'createdAt' => $date,
+                'updatedAt' => $date,
+            ],
+        ], $this->model->paginate(1, 10, [
+            ['id', '>', 0],
+            ['data', 'is not null'],
+        ], 'id'));
+        self::assertSame([
+            [
+                'id' => 2,
+                'data' => 'bar',
+                'createdAt' => $date,
+                'updatedAt' => $date,
+            ],
+            [
+                'id' => 1,
+                'data' => 'foo',
+                'createdAt' => $date,
+                'updatedAt' => $date,
+            ],
+        ], $this->model->paginate(1, 10, [
+            ['id', '>', 0],
+            ['data', 'is not null'],
+        ], 'id', 'desc'));
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Invalid ORDER BY direction: Foo');
+        $this->model->paginate(1, 10, [], 'id', 'Foo');
     }
 
     public function testPaginatedUrl() : void