Add PaginatorIterator

zendesk · Oct 31, 2023 · eaab3b2 · eaab3b2
1 parent 9d2811a
commit eaab3b2
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 29 deletions.
diff --git a/src/Zendesk/API/Resources/Core/SharingAgreements.php b/src/Zendesk/API/Resources/Core/SharingAgreements.php
@@ -4,7 +4,6 @@
 
 use Zendesk\API\Resources\ResourceAbstract;
 use Zendesk\API\Traits\Resource\FindAll;
-use Zendesk\API\Traits\Utility\Pagination\ObpStrategy;
 use Zendesk\API\Traits\Utility\Pagination\SinglePageStrategy;
 
 /**

diff --git a/src/Zendesk/API/Traits/Resource/Pagination.php b/src/Zendesk/API/Traits/Resource/Pagination.php
@@ -7,7 +7,6 @@
 use Zendesk\API\Traits\Utility\Pagination\PaginationIterator;
 
 trait Pagination {
-
     /**
      * Usage:
      * foreach ($ticketsIterator as $ticket) {
@@ -19,15 +18,21 @@ trait Pagination {
     public function iterator()
     {
         $strategyClass = $this->paginationStrategyClass();
-        $strategy = new $strategyClass($this, $this->resourcesKey(), AbstractStrategy::DEFAULT_PAGE_SIZE);
-        return new PaginationIterator($strategy);
+        $strategy = new $strategyClass($this->resourcesKey(), AbstractStrategy::DEFAULT_PAGE_SIZE);
+        return new PaginationIterator($this, $strategy);
     }
 
+    /**
+     * Override this method in your resources
+     *
+     * @return string subclass of AbstractStrategy used for fetching pages
+     */
+
     protected function paginationStrategyClass() {
         return CbpStrategy::class;
     }
 
-    /*
+    /**
      * @return string eg: "job_statuses"
      */
     protected function resourcesKey() {

diff --git a/src/Zendesk/API/Traits/Utility/Pagination/AbstractStrategy.php b/src/Zendesk/API/Traits/Utility/Pagination/AbstractStrategy.php
@@ -5,24 +5,18 @@ abstract class AbstractStrategy
 {
     public const DEFAULT_PAGE_SIZE = 100;
 
-    /*
-     * @var mixed use trait FindAll. The object handling the list, Ie: `$client->{clientList}()`
-     */
-    protected $clientList;
-
-    /*
+    /**
      * @var string The response key where the data is returned
      */
     protected $resourcesKey;
     protected $pageSize;
 
-    public function __construct($clientList, $resourcesKey, $pageSize = self::DEFAULT_PAGE_SIZE)
+    public function __construct($resourcesKey, $pageSize = self::DEFAULT_PAGE_SIZE)
     {
-        $this->clientList = $clientList;
         $this->resourcesKey = $resourcesKey;
         $this->pageSize = $pageSize;
     }
 
-    abstract public function getPage();
+    abstract public function getPage($pageFn);
     abstract public function shouldGetPage($position);
 }
diff --git a/src/Zendesk/API/Traits/Utility/Pagination/CbpStrategy.php b/src/Zendesk/API/Traits/Utility/Pagination/CbpStrategy.php
@@ -2,19 +2,23 @@
 
 namespace Zendesk\API\Traits\Utility\Pagination;
 
+/**
+ * Cursor Based Pagination
+ * Used in paginationStrategyClass
+ */
 class CbpStrategy extends AbstractStrategy
 {
     private $afterCursor = null;
     private $started = false;
 
-    public function getPage()
+    public function getPage($pageFn)
     {
         $this->started = true;
         $params = ['page[size]' => $this->pageSize];
         if ($this->afterCursor) {
             $params['page[after]'] = $this->afterCursor;
         }
-        $response = $this->clientList->findAll($params);
+        $response = $pageFn($params);
 
         $this->afterCursor = $response->meta->has_more ? $response->meta->after_cursor : null;
         return $response->{$this->resourcesKey};

diff --git a/src/Zendesk/API/Traits/Utility/Pagination/ObpStrategy.php b/src/Zendesk/API/Traits/Utility/Pagination/ObpStrategy.php
@@ -2,19 +2,19 @@
 
 namespace Zendesk\API\Traits\Utility\Pagination;
 
-
 /**
  * Offset Based Pagination
+ * Used in paginationStrategyClass
  */
 class ObpStrategy extends AbstractStrategy
 {
     private $pageNumber = 0;
 
-    public function getPage()
+    public function getPage($pageFn)
     {
         ++$this->pageNumber;
         $params = ['page' => $this->pageNumber, 'page_size' => $this->pageSize];
-        $response = $this->clientList->findAll($params);
+        $response = $pageFn($params);
 
         return $response->{$this->resourcesKey};
     }

diff --git a/src/Zendesk/API/Traits/Utility/Pagination/PaginationIterator.php b/src/Zendesk/API/Traits/Utility/Pagination/PaginationIterator.php
@@ -9,9 +9,14 @@ class PaginationIterator implements Iterator
     private $position = 0;
     private $page = [];
     private $strategy;
+    /**
+     * @var mixed use trait FindAll. The object handling the list, Ie: `$client->{clientList}()`
+     */
+    private $clientList;
 
-    public function __construct(AbstractStrategy $strategy)
+    public function __construct($clientList, AbstractStrategy $strategy)
     {
+        $this->clientList = $clientList;
         $this->strategy = $strategy;
     }
 
@@ -32,7 +37,7 @@ public function rewind()
 
     public function valid()
     {
-        $this->getPageIfNecessary();
+        $this->getPageIfNeeded();
         return !!$this->current();
     }
 
@@ -45,12 +50,16 @@ public function current()
         }
     }
 
-    private function getPageIfNecessary()
+    private function getPageIfNeeded()
     {
         if (!$this->strategy->shouldGetPage($this->position)) {
             return;
         }
 
-        $this->page = array_merge($this->page, $this->strategy->getPage());
+        $pageFn = function ($params = []) {
+            return $this->clientList->findAll($params);
+        };
+
+        $this->page = array_merge($this->page, $this->strategy->getPage($pageFn));
     }
 }
diff --git a/src/Zendesk/API/Traits/Utility/Pagination/SinglePageStrategy.php b/src/Zendesk/API/Traits/Utility/Pagination/SinglePageStrategy.php
@@ -5,15 +5,16 @@
 
 /**
  * Single Page (no pagination)
+ * Used in paginationStrategyClass
  */
 class SinglePageStrategy extends AbstractStrategy
 {
     protected $started = false;
 
-    public function getPage()
+    public function getPage($pageFn)
     {
         $this->started = true;
-        $response = $this->clientList->findAll();
+        $response = $pageFn();
 
         return $response->{$this->resourcesKey};
     }

diff --git a/tests/Zendesk/API/UnitTests/Traits/Utility/PaginationTest.php b/tests/Zendesk/API/UnitTests/Traits/Utility/PaginationTest.php
@@ -48,8 +48,8 @@ public function testFetchesTickets()
             [['id' => 1], ['id' => 2]],
             [['id' => 3], ['id' => 4]]
         ]);
-        $strategy = new CbpStrategy($mockTickets, 'tickets', 2);
-        $iterator = new PaginationIterator($strategy);
+        $strategy = new CbpStrategy('tickets', 2);
+        $iterator = new PaginationIterator($mockTickets, $strategy);
 
         $tickets = iterator_to_array($iterator);
 
@@ -62,8 +62,8 @@ public function testFetchesUsers()
             [['id' => 1, 'name' => 'User 1'], ['id' => 2, 'name' => 'User 2']],
             [['id' => 3, 'name' => 'User 3'], ['id' => 4, 'name' => 'User 4']]
         ]);
-        $strategy = new CbpStrategy($mockUsers, 'users', 2);
-        $iterator = new PaginationIterator($strategy);
+        $strategy = new CbpStrategy('users', 2);
+        $iterator = new PaginationIterator($mockUsers, $strategy);
 
         $users = iterator_to_array($iterator);