Merge pull request #6 from craigpotter/feature/use-new-pagination

Implement Saloon Pagination v2

composer.json

@@ -13,7 +13,8 @@
     "homepage": "https://github.com/craigpotter",
     "require": {
         "php": "^8.1",
-        "saloonphp/saloon": "^2.0"
+        "saloonphp/saloon": "^2.0",
+        "saloonphp/pagination-plugin": "^1.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.5",

src/Fca.php

@@ -7,12 +7,12 @@
 use Saloon\Http\Connector;
 use Saloon\Contracts\Request;
 use Saloon\Contracts\Response;
-use Saloon\Contracts\Paginator;
-use Saloon\Contracts\HasPagination;
+use Saloon\PaginationPlugin\Paginator;
 use CraigPotter\Fca\Requests\GetEndpoint;
-use Saloon\Http\Paginators\PagedPaginator;
 use CraigPotter\Fca\Resources\FirmResource;
+use Saloon\PaginationPlugin\PagedPaginator;
 use Saloon\Traits\Plugins\AlwaysThrowOnErrors;
+use Saloon\PaginationPlugin\Contracts\HasPagination;
 
 class Fca extends Connector implements HasPagination
 {
@@ -74,22 +74,64 @@ public function firm(int $frn): FirmResource
         return new FirmResource($this, $frn);
     }
 
+    /**
+     * Get an endpoint
+     *
+     * @param string $endpoint
+     * @return Paginator
+     */
     public function getEndpoint(string $endpoint): Paginator
     {
         return $this->paginate(new GetEndpoint($endpoint));
     }
 
-    public function paginate(Request $request, ...$additionalArguments): Paginator
+    public function paginate(Request $request, ...$additionalArguments): PagedPaginator
     {
-        /** @var PagedPaginator $paginator */
-        $paginator = new PagedPaginator($this, $request, 20, ...$additionalArguments);
+        return new class(connector: $this, request: $request) extends PagedPaginator {
+            protected ?int $perPageLimit = 20;
+
+            /**
+             * Determine if the response is the last page
+             *
+             * @param Response $response
+             * @return bool
+             */
+            protected function isLastPage(Response $response): bool
+            {
+                $count = (int) $response->json('ResultInfo.total_count', 0);
+                $perPage = (int) $response->json('ResultInfo.per_page', $count);
+                $currentPage = (int) $response->json('ResultInfo.page', 1);
+
+                return $count <= ($perPage * $currentPage);
+
+            }
+
+            /**
+             * Get the results from the page
+             *
+             * @return array
+             */
+            protected function getPageItems(Response $response, Request $request): array
+            {
+                return $request->createDtoFromResponse($response);
+            }
+
+            /**
+             * Apply pagination to the request
+             *
+             * @param Request $request
+             * @return Request
+             */
+            protected function applyPagination(Request $request): Request
+            {
+                $request->query()->add('pgnp', $this->page);
 
-        $paginator->setTotalKeyName('ResultInfo.total_count');
-        $paginator->setPageKeyName('pgnp');
-        $paginator->setLimit(20);
-        $paginator->setNextPageKeyName('ResultInfo.Next');
-        $paginator->setCurrentPage(1);
+                if (isset($this->perPageLimit)) {
+                    $request->query()->add('pageSize', $this->perPageLimit);
+                }
 
-        return $paginator;
+                return $request;
+            }
+        };
     }
 }

src/Requests/Firm/GetFirmAddresses.php

@@ -8,8 +8,9 @@
 use Saloon\Http\Request;
 use Saloon\Contracts\Response;
 use CraigPotter\Fca\DataObjects\Address;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetFirmAddresses extends Request
+class GetFirmAddresses extends Request implements Paginatable
 {
     /**
      * The HTTP method of the request.

src/Requests/Firm/GetFirmIndividuals.php

@@ -8,8 +8,9 @@
 use Saloon\Http\Request;
 use Saloon\Contracts\Response;
 use CraigPotter\Fca\DataObjects\Individual;
+use Saloon\PaginationPlugin\Contracts\Paginatable;
 
-class GetFirmIndividuals extends Request
+class GetFirmIndividuals extends Request implements Paginatable
 {
     /**
      * The HTTP method of the request.

src/Resources/FirmResource.php

@@ -5,7 +5,7 @@
 namespace CraigPotter\Fca\Resources;
 
 use Saloon\Http\Response;
-use Saloon\Http\Paginators\PagedPaginator;
+use Saloon\PaginationPlugin\PagedPaginator;
 use Saloon\Exceptions\Request\RequestException;
 use CraigPotter\Fca\Requests\Firm\GetFirmDetails;
 use CraigPotter\Fca\Requests\Firm\GetFirmAddresses;