Merge pull request #53 from picqer/pagination

Add pagination to FindAll trait

Author: casperbakker

src/Picqer/Carriers/SendCloud/Query/FindAll.php

@@ -13,15 +13,36 @@
  */
 trait FindAll
 {
-
-    public function all($params = [])
+    public function all($params = [], ?int $maxPages = 1): array
     {
-        $result = $this->connection()->get($this->url, $params);
+        $allRecords = [];
+        $pages = 0;
+
+        while (true) {
+            $result = $this->connection()->get($this->url, $params);
+
+            $allRecords = array_merge($allRecords, $this->collectionFromResult($result));
+
+            if (! empty($result['next'])) {
+                // Get the querystring params from the next url, so we can retrieve the next page
+                $params = parse_url($result['next'], PHP_URL_QUERY);
+            } else {
+                // If no next page is found, all records are complete
+                break;
+            }
 
-        return $this->collectionFromResult($result);
+            $pages++;
+
+            // If max pages is set and reached, also stop the loop
+            if (! is_null($maxPages) && $pages >= $maxPages) {
+                break;
+            }
+        }
+
+        return $allRecords;
     }
 
-    public function collectionFromResult($result)
+    public function collectionFromResult($result): array
     {
         $collection = [];
 
@@ -36,5 +57,4 @@ public function collectionFromResult($result)
 
         return $collection;
     }
-
 }

src/Picqer/Carriers/SendCloud/Query/FindOne.php

@@ -4,6 +4,7 @@
 
 use Picqer\Carriers\SendCloud\Connection;
 use Picqer\Carriers\SendCloud\Model;
+use Picqer\Carriers\SendCloud\SendCloudApiException;
 
 /**
  * Trait FindOne
@@ -14,10 +15,10 @@
  */
 trait FindOne
 {
-
     /**
      * @param $id
      * @return Model|FindOne
+     * @throws SendCloudApiException
      */
     public function find($id)
     {

src/Picqer/Carriers/SendCloud/Query/Findable.php

@@ -4,8 +4,6 @@
 
 trait Findable
 {
-
     use FindOne;
     use FindAll;
-
-}
+}