Add paginator service for pagination logic

Author: joepdooper

src/Shared/Base/Entity.php

@@ -3,6 +3,7 @@
 namespace Ivy\Shared\Base;
 
 use Illuminate\Database\Eloquent\Model;
+use Ivy\Shared\Domain\Collection\EntityCollection;
 
 /**
  * @method static static where(string $column, mixed $value = null)
@@ -19,5 +20,17 @@
  */
 abstract class Entity extends Model
 {
+    public function newCollection(array $models = []): EntityCollection
+    {
+        $collection = new EntityCollection($models);
 
+        if (
+            method_exists(static::class, 'pagination') &&
+            static::pagination()
+        ) {
+            $collection->setPagination(static::pagination());
+        }
+
+        return $collection;
+    }
 }

src/Shared/Domain/Collection/EntityCollection.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Ivy\Shared\Domain\Collection;
+
+use Illuminate\Database\Eloquent\Collection;
+use Ivy\Shared\Domain\Data\PaginationResult;
+
+class EntityCollection extends Collection
+{
+    protected ?PaginationResult $pagination = null;
+
+    public function setPagination(PaginationResult $pagination): static
+    {
+        $this->pagination = $pagination;
+
+        return $this;
+    }
+
+    public function pagination(): ?PaginationResult
+    {
+        return $this->pagination;
+    }
+}

src/Shared/Domain/Data/PaginationResult.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Ivy\Shared\Domain\Data;
+
+use Illuminate\Support\Collection;
+
+class PaginationResult
+{
+    public function __construct(
+        public readonly int $currentPage,
+        public readonly int $perPage,
+        public readonly int $total,
+        public readonly int $lastPage,
+        public array $perPageOptions = [5, 10, 25, 50, 100],
+    ) {}
+
+    public function pages(): array
+    {
+        return range(1, $this->lastPage);
+    }
+
+    public function from(): int
+    {
+        return ($this->currentPage - 1) * $this->perPage + 1;
+    }
+
+    public function to(): int
+    {
+        return min($this->currentPage * $this->perPage, $this->total);
+    }
+
+    public function hasNext(): bool
+    {
+        return $this->currentPage < $this->lastPage;
+    }
+
+    public function hasPrevious(): bool
+    {
+        return $this->currentPage > 1;
+    }
+}

src/Shared/Infrastructure/Service/PaginationService.php

@@ -3,37 +3,35 @@
 namespace Ivy\Shared\Infrastructure\Service;
 
 use Illuminate\Database\Eloquent\Builder;
+use Ivy\Shared\Domain\Data\PaginationResult;
 use Symfony\Component\HttpFoundation\Request;
 
 class PaginationService
 {
-    public function paginate(
+    public function apply(
         Builder $query,
         Request $request,
         int $perPage = 25
-    ): array {
+    ): Builder {
 
         $page = max(1, (int) $request->query->get('page', 1));
+        $perPage = max(1, (int) $request->query->get('per_page', $perPage));
 
         $total = (clone $query)->count();
 
-        $items = $query
+        $modelClass = get_class($query->getModel());
+
+        $modelClass::setPagination(
+            new PaginationResult(
+                currentPage: $page,
+                perPage: $perPage,
+                total: $total,
+                lastPage: (int) ceil($total / $perPage),
+            )
+        );
+
+        return $query
             ->offset(($page - 1) * $perPage)
-            ->limit($perPage)
-            ->get();
-
-        $lastPage = (int) ceil($total / $perPage);
-
-        return [
-            'data' => $items,
-            'meta' => [
-                'current_page' => $page,
-                'per_page' => $perPage,
-                'total' => $total,
-                'last_page' => $lastPage,
-                'has_next' => $page < $lastPage,
-                'has_prev' => $page > 1,
-            ],
-        ];
+            ->limit($perPage);
     }
 }

src/Shared/Traits/HasPagination.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Ivy\Shared\Traits;
+
+use Illuminate\Container\Container;
+use Illuminate\Database\Eloquent\Builder;
+use Ivy\Shared\Domain\Data\PaginationResult;
+use Ivy\Shared\Infrastructure\Service\PaginationService;
+use Symfony\Component\HttpFoundation\Request;
+
+trait HasPagination
+{
+    protected static ?PaginationResult $pagination = null;
+
+    public static function pagination(): ?PaginationResult
+    {
+        return static::$pagination;
+    }
+
+    public static function setPagination(PaginationResult $pagination): void
+    {
+        static::$pagination = $pagination;
+    }
+
+    public function scopePaged(
+        Builder $query,
+        Request $request,
+    ): Builder {
+
+        return Container::getInstance()->get(PaginationService::class)->apply($query, $request);
+    }
+}

src/Template/Presentation/View/Engine/LatteEngine.php

@@ -178,21 +178,17 @@ private function registerFunctions(): void
             $key ?? $default
         );
 
-        $this->latte->addFunction('sortUrl', function (string $column) {
+        $this->latte->addFunction('queryUrl', function (array $replace = [], array $remove = []) {
 
             $query = $this->request->query->all();
 
-            $currentSort = $query['sort'] ?? null;
-            $currentDirection = $query['direction'] ?? 'asc';
+            foreach ($replace as $key => $value) {
+                $query[$key] = $value;
+            }
 
-            $query['sort'] = $column;
-
-            $query['direction'] =
-                ($currentSort === $column && $currentDirection === 'asc')
-                    ? 'desc'
-                    : 'asc';
-
-            unset($query['page']);
+            foreach ($remove as $key) {
+                unset($query[$key]);
+            }
 
             return '?' . http_build_query($query);
         });
@@ -205,6 +201,6 @@ private function registerExtensions(): void
 
     private function registerProviders(): void
     {
-        
+
     }
 }