Merge pull request #524 from zendesk/RED-1955-iterator-page

PaginationIterator storing only one page at a time

Author: ecoologic

README.md

@@ -155,7 +155,10 @@ foreach ($iterator as $ticket) {
   * Refer to the docs for details, including allowed sort fields
 * Combine everything: `$params = ['page[size]' => 2, 'sort' => 'updated_at', 'extra' => 'param'];`
 
-**Note**: Refer to the documentation for the correct params for sorting with the pagination type you're using.
+**Note**:
+
+* Refer to the documentation for the correct params for sorting with the pagination type you're using
+* The helper method `iterator_to_array` doesn't work with this implementation
 
 ##### Iterator API call response
 

src/Zendesk/API/Traits/Utility/Pagination/AbstractStrategy.php

@@ -53,5 +53,5 @@ protected function pageSize()
     }
 
     abstract public function page($getPageFn);
-    abstract public function shouldGetPage($position);
+    abstract public function shouldGetPage($current_page);
 }

src/Zendesk/API/Traits/Utility/Pagination/CbpStrategy.php

@@ -29,7 +29,7 @@ public function page($getPageFn)
         return $this->latestResponse->{$this->resourcesKey};
     }
 
-    public function shouldGetPage($position) {
+    public function shouldGetPage($current_page) {
         return !$this->started || $this->hasMore;
     }
 

src/Zendesk/API/Traits/Utility/Pagination/ObpStrategy.php

@@ -18,7 +18,7 @@ public function page($getPageFn)
         return $response->{$this->resourcesKey};
     }
 
-    public function shouldGetPage($position) {
-        return $this->pageNumber == 0 || $position >= $this->pageNumber * $this->pageSize();
+    public function shouldGetPage($current_page) {
+        return $this->pageNumber == 0 || count($current_page) == 0;
     }
 }

src/Zendesk/API/Traits/Utility/Pagination/PaginationIterator.php

@@ -14,7 +14,7 @@ class PaginationIterator implements Iterator
     private $strategy;
     private $method;
     private $position = 0;
-    private $items = [];
+    private $page = [];
 
     /**
      * @param mixed using trait FindAll. The resources collection, Eg: `$client->tickets()` which uses FindAll
@@ -56,8 +56,8 @@ public function valid()
     #[\ReturnTypeWillChange]
     public function current()
     {
-        if (isset($this->items[$this->position])) {
-            return $this->items[$this->position];
+        if (isset($this->page[$this->position])) {
+            return $this->page[$this->position];
         } else {
             return null;
         }
@@ -74,14 +74,14 @@ public function latestResponse()
     }
     private function getPageIfNeeded()
     {
-        if (isset($this->items[$this->position]) || !$this->strategy->shouldGetPage($this->position)) {
+        if (isset($this->page[$this->position]) || !$this->strategy->shouldGetPage($this->page)) {
             return;
         }
 
         $getPageFn = function () {
             return $this->clientList->{$this->method}($this->strategy->params());
         };
-
-        $this->items = array_merge($this->items, $this->strategy->page($getPageFn));
+        $this->page = $this->strategy->page($getPageFn);
+        $this->position = 0;
     }
 }

src/Zendesk/API/Traits/Utility/Pagination/SinglePageStrategy.php

@@ -19,7 +19,7 @@ public function page($getPageFn)
         return $response->{$this->resourcesKey};
     }
 
-    public function shouldGetPage($position) {
+    public function shouldGetPage($current_page) {
         return !$this->started;
     }
 }

tests/Zendesk/API/UnitTests/BasicTest.php

@@ -236,4 +236,20 @@ protected function assertEndpointCalled($userFunction, $endpoint, $method = 'GET
             ])
         );
     }
+
+    /**
+     * replacement for iterator_to_array
+     * which doesn't work when storing with single page
+     *
+     * @param \Iterator $iterator
+     * @return array all the items
+     */
+    protected function iterator_to_array($iterator)
+    {
+        $results = [];
+        foreach ($iterator as $item) {
+            $results[] = $item;
+        }
+        return $results;
+    }
 }

tests/Zendesk/API/UnitTests/Core/AutomationsTest.php

@@ -40,7 +40,7 @@ public function testIterator()
 
         $iterator = $this->client->automations()->iterator();
 
-        $actual = iterator_to_array($iterator);
+        $actual = $this->iterator_to_array($iterator);
         $this->assertCount(3, $actual);
         $this->assertEquals($this->testResource0['anyField'], $actual[0]->anyField);
         $this->assertEquals($this->testResource1['anyField'], $actual[1]->anyField);
@@ -65,7 +65,7 @@ public function testIteratorFindActive()
 
         $iterator = $this->client->automations()->iterator([], 'findActive');
 
-        $actual = iterator_to_array($iterator);
+        $actual = $this->iterator_to_array($iterator);
 
         $this->assertLastRequestIs(
             [

tests/Zendesk/API/UnitTests/Core/MacrosTest.php

@@ -41,7 +41,7 @@ public function testIterator()
 
         $iterator = $this->client->macros()->iterator();
 
-        $actual = iterator_to_array($iterator);
+        $actual = $this->iterator_to_array($iterator);
         $this->assertCount(3, $actual);
         $this->assertEquals($this->testResource0['anyField'], $actual[0]->anyField);
         $this->assertEquals($this->testResource1['anyField'], $actual[1]->anyField);

tests/Zendesk/API/UnitTests/Core/OrganizationMembershipsTest.php

@@ -40,7 +40,7 @@ public function testIterator()
 
         $iterator = $this->client->organizationMemberships()->iterator();
 
-        $actual = iterator_to_array($iterator);
+        $actual = $this->iterator_to_array($iterator);
         $this->assertCount(3, $actual);
         $this->assertEquals($this->testResource0['anyField'], $actual[0]->anyField);
         $this->assertEquals($this->testResource1['anyField'], $actual[1]->anyField);