Merge pull request #11 from saloonphp/fix/v2-deprecate-invalid-page-property

Fix | v2 - Deprecate Invalid Page Property

Author: Sammyjo20

src/Paginator.php

@@ -37,9 +37,16 @@ abstract class Paginator implements Iterator, Countable
 
     /**
      * Internal Marker For The Current Page
+     *
+     * @deprecated Use $currentPage instead
      */
     protected int $page = 1;
 
+    /**
+     * Denotes the current page
+     */
+    protected int $currentPage = 0;
+
     /**
      * When using async this is the total number of pages
      */
@@ -169,22 +176,23 @@ public function current(): Response|PromiseInterface
     public function next(): void
     {
         $this->page++;
+        $this->currentPage++;
     }
 
     /**
      * Get the key of the paginator
      */
     public function key(): int
     {
-        return $this->page - 1;
+        return $this->currentPage;
     }
 
     /**
      * Check if the paginator has another page to retrieve
      */
     public function valid(): bool
     {
-        if (isset($this->maxPages) && $this->page > $this->maxPages) {
+        if (isset($this->maxPages) && ($this->currentPage + 1) > $this->maxPages) {
             return false;
         }
 
@@ -193,7 +201,7 @@ public function valid(): bool
         }
 
         if ($this->isAsyncPaginationEnabled()) {
-            return $this->page <= $this->totalPages ??= $this->getTotalPages($this->currentResponse);
+            return ($this->currentPage + 1) <= $this->totalPages ??= $this->getTotalPages($this->currentResponse);
         }
 
         return $this->isLastPage($this->currentResponse) === false;
@@ -204,6 +212,7 @@ public function valid(): bool
      */
     public function rewind(): void
     {
+        $this->currentPage = max(0, $this->startPage - 1);
         $this->page = $this->startPage;
         $this->currentResponse = null;
         $this->totalResults = 0;
@@ -309,12 +318,22 @@ public function getOriginalRequest(): Request
 
     /**
      * Get page
+     *
+     * @deprecated Use currentPage() instead
      */
     public function getPage(): int
     {
         return $this->page;
     }
 
+    /**
+     * Get the current page
+     */
+    public function getCurrentPage(): int
+    {
+        return $this->currentPage;
+    }
+
     /**
      * Set the start page of the paginator
      *