add-cursor-paginate

Author: Marius

README.md

@@ -209,20 +209,21 @@ Json Response:
            "column_name1",
            "column_name2"
         ],
-        "current_page": 1,
+        "current_page": 1, // not present when cursor is present in request 
         "data": [
             {
                "identifier":"value",
                "column_name":"value",
                ...
             }
         ],
-        "from": 1,
-        "last_page": 1, // not present when simplePaginate is true in controller or present on request
+        "from": 1, // not present when cursor is present in request
+        "last_page": 1, // not present when cursor is present in request or when simplePaginate is true in controller or present in request
         "per_page": 10,
-        "to": 1,
-        "total": 1, // not present when simplePaginate is true in controller or present on request
-        "has_more_pages": bool
+        "to": 1, // not present when cursor is present in request
+        "total": 1, // not present when cursor is present in request or simplePaginate is true in controller or present in request
+        "has_more_pages": bool,
+        "cursor": "..." // present only when cursor is present in request
     }
 
 and for application/xls: binary with contents from `data`
@@ -232,16 +233,19 @@ The reserved words / parameters that will be used as query params are:
         page,
         limit,
         simplePaginate
+        cursor
 
 Defaults:
 
     page=1;
     limit=10;
     simplePaginate is false by default and only its presence is check in request, not its value
+    cursor is not defined
 
 Obs.
 
     index_required_on_filtering key CAN'T be used for filtering.
+    use ?cursor= for cursor pagination and ?simplePaginate=1 for simplePaginate. Use none of them for length aware paginator.
 
 #### I.4 Update resource (or create)
 **PUT** /{resource}/{identifier}

src/Exports/ListResourceExcel.php

@@ -2,8 +2,10 @@
 
 namespace MacropaySolutions\LaravelCrudWizard\Exports;
 
-use Illuminate\Pagination\AbstractPaginator;
 use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Pagination\CursorPaginator;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
@@ -24,7 +26,7 @@ class ListResourceExcel implements WithMultipleSheets
 
     public function __construct(
         BaseModel $baseModel,
-        AbstractPaginator $lap,
+        LengthAwarePaginator | Paginator | CursorPaginator $lap,
         array $withRelations = [],
         ?BaseModel $baseResourceModel = null
     ) {

src/Http/Controllers/ResourceControllerTrait.php

@@ -2,9 +2,12 @@
 
 namespace MacropaySolutions\LaravelCrudWizard\Http\Controllers;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
+use Illuminate\Pagination\CursorPaginator;
 use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Facades\Log;
@@ -166,13 +169,9 @@ protected function getFilteredRelations(array $relations, ?BaseModel $baseModel
     protected function handleList(array $allRequest, Request $request): Response
     {
         try {
-            $paginator = $this->resourceService->list(
+            $paginator = $this->getPaginator(
+                $this->resourceService->list($allRequest),
                 $allRequest
-            )->{$this->simplePaginate ? 'simplePaginate' : 'paginate'}(
-                max((int)($allRequest['limit'] ?? 10), 1),
-                ['*'],
-                'page',
-                \max((int)($allRequest['page'] ?? 1), 1)
             );
 
             if ($request->header('Accept') === 'application/xls') {
@@ -225,10 +224,14 @@ protected function getEmptyPaginatedResponse(array $request): JsonResponse
         );
     }
 
-    protected function getJsonResponse(LengthAwarePaginator | Paginator $paginator, array $appends = []): JsonResponse
-    {
+    protected function getJsonResponse(
+        LengthAwarePaginator | Paginator | CursorPaginator $paginator,
+        array $appends = []
+    ): JsonResponse {
         return GeneralHelper::app(JsonResponse::class, [
-            'data' => \array_merge([
+            'data' => \array_merge($paginator instanceof CursorPaginator ? [
+                'cursor' => $paginator->nextCursor()->encode(),
+            ] : [], [
                 'has_more_pages' => $paginator->hasMorePages(),
             ], $appends, GeneralHelper::filterDataByKeys(
                 $paginator->toArray(),
@@ -275,7 +278,7 @@ protected function getDownloadHeaders(): array
         return [];
     }
 
-    protected function downloadXLS(LengthAwarePaginator | Paginator $paginator): Response
+    protected function downloadXLS(LengthAwarePaginator | Paginator | CursorPaginator $paginator): Response
     {
         /** @var ListResourceExcel $exporter */
         $exporter = GeneralHelper::app(ListResourceExcel::class, [
@@ -292,6 +295,30 @@ protected function downloadXLS(LengthAwarePaginator | Paginator $paginator): Res
 
     protected function setSimplePaginate(array $allRequest): void
     {
-        $this->simplePaginate = isset($allRequest['simplePaginate']) ? true : $this->simplePaginate;
+        $this->simplePaginate = isset($allRequest['simplePaginate'])
+            || isset($allRequest['cursor']) ? true : $this->simplePaginate;
+    }
+    /**
+     * @throws \Throwable
+     */
+    protected function getPaginator(
+        Builder | Relation $builder,
+        array $allRequest
+    ): LengthAwarePaginator | Paginator | CursorPaginator {
+        if (isset($allRequest['cursor'])) {
+            return $builder->cursorPaginate(
+                max((int)($allRequest['limit'] ?? 10), 1),
+                ['*'],
+                'cursor',
+                $allRequest['cursor']
+            );
+        }
+
+        return $builder->{$this->simplePaginate ? 'simplePaginate' : 'paginate'}(
+            max((int)($allRequest['limit'] ?? 10), 1),
+            ['*'],
+            'page',
+            \max((int)($allRequest['page'] ?? 1), 1)
+        );
     }
 }