Merge pull request #166 from Sammyjo20/fix/v2-cursor-paginator-properties

Fix | V2 Fixed cursorPaginator properties

Author: Sammyjo20

src/Http/Paginators/CursorPaginator.php

@@ -36,14 +36,14 @@ class CursorPaginator extends Paginator
      *
      * @var string
      */
-    protected string $nextPageKey = 'next_page_url';
+    protected string $nextPageKeyName = 'next_page_url';
 
     /**
      * The key/query parameter that contains the cursor
      *
      * @var string
      */
-    protected string $cursorKey = 'cursor';
+    protected string $cursorKeyName = 'cursor';
 
     /**
      * Constructor
@@ -99,7 +99,7 @@ protected function applyPagination(Request $request): void
             $request->query()->add($this->getLimitKeyName(), $this->limit());
         }
 
-        $request->query()->add($this->getCursorKey(), $this->currentCursor);
+        $request->query()->add($this->getCursorKeyName(), $this->currentCursor);
     }
 
     /**
@@ -114,7 +114,7 @@ protected function isFinished(): bool
             return $this->currentPage > $this->totalPages();
         }
 
-        return is_null($this->currentResponse->json($this->getNextPageKey()));
+        return is_null($this->currentResponse->json($this->getNextPageKeyName()));
     }
 
     /**
@@ -135,41 +135,41 @@ public function key(): string|int
      */
     protected function getCursor(): string|int|null
     {
-        $rawQuery = parse_url($this->currentResponse->json($this->getNextPageKey()) ?? '', PHP_URL_QUERY);
+        $rawQuery = parse_url($this->currentResponse->json($this->getNextPageKeyName()) ?? '', PHP_URL_QUERY);
 
         if (empty($rawQuery)) {
             return null;
         }
 
         parse_str($rawQuery, $query);
 
-        $cursorValue = $query[$this->getCursorKey()] ?? null;
+        $cursorValue = $query[$this->getCursorKeyName()] ?? null;
 
         return is_array($cursorValue) ? $cursorValue[0] : $cursorValue;
     }
 
     /**
      * Set the JSON key for the next page URL that contains the cursor
      *
-     * @param string $nextPageKey
+     * @param string $nextPageKeyName
      * @return $this
      */
-    public function setNextPageKey(string $nextPageKey): static
+    public function setNextPageKeyName(string $nextPageKeyName): static
     {
-        $this->nextPageKey = $nextPageKey;
+        $this->nextPageKeyName = $nextPageKeyName;
 
         return $this;
     }
 
     /**
      * Set the key/query parameter that contains the cursor
      *
-     * @param string $cursorKey
+     * @param string $cursorKeyName
      * @return $this
      */
-    public function setCursorKey(string $cursorKey): static
+    public function setCursorKeyName(string $cursorKeyName): static
     {
-        $this->cursorKey = $cursorKey;
+        $this->cursorKeyName = $cursorKeyName;
 
         return $this;
     }
@@ -179,18 +179,18 @@ public function setCursorKey(string $cursorKey): static
      *
      * @return string
      */
-    public function getNextPageKey(): string
+    public function getNextPageKeyName(): string
     {
-        return $this->nextPageKey;
+        return $this->nextPageKeyName;
     }
 
     /**
      * Get the cursor key
      *
      * @return string
      */
-    public function getCursorKey(): string
+    public function getCursorKeyName(): string
     {
-        return $this->cursorKey;
+        return $this->cursorKeyName;
     }
 }

tests/Unit/RequestPaginationTest.php

@@ -328,12 +328,12 @@
     $request = new CursorGetSuperHeroesRequest;
     $paginator = $connector->paginate($request);
 
-    expect($paginator->getNextPageKey())->toEqual('next_page_url');
-    expect($paginator->getCursorKey())->toEqual('cursor');
+    expect($paginator->getNextPageKeyName())->toEqual('next_page_url');
+    expect($paginator->getCursorKeyName())->toEqual('cursor');
 
-    $paginator->setNextPageKey('next');
-    $paginator->setCursorKey('token');
+    $paginator->setNextPageKeyName('next');
+    $paginator->setCursorKeyName('token');
 
-    expect($paginator->getNextPageKey())->toEqual('next');
-    expect($paginator->getCursorKey())->toEqual('token');
+    expect($paginator->getNextPageKeyName())->toEqual('next');
+    expect($paginator->getCursorKeyName())->toEqual('token');
 });