Add support for pagination from the REST API

krystal · Jul 15, 2020 · 489aac0 · 489aac0
1 parent 911361a
commit 489aac0
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 13 deletions.
diff --git a/src/API/RestfulKatapultApiV1/Helper.php b/src/API/RestfulKatapultApiV1/Helper.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Krystal\Katapult\API\RestfulKatapultApiV1;
+
+class Helper
+{
+    public static function addQueryToUrl($url, $arguments = null)
+    {
+        if($arguments && isset($arguments['query']))
+        {
+            $url .= '?' . http_build_query($arguments['query']);
+        }
+
+        return $url;
+    }
+}
diff --git a/src/API/RestfulKatapultApiV1/ResourceController.php b/src/API/RestfulKatapultApiV1/ResourceController.php
@@ -103,14 +103,29 @@ public function createApiUrl($resourceId = null, $contextualArguments = null)
      */
     public function all()
     {
-        $res = $this->api->get($this->createApiUrl());
+        $lastFetchedPage = null;
+        $nextPage = 1;
+        $totalPages = null;
 
         $resources = [];
         $resourceClass = $this->mappedResourceClass; // Due to lacking Uniform Variable Syntax in PHP < 7
 
-        foreach(\GuzzleHttp\json_decode($res->getBody())->{$this->resourceNamePlural} as $resourceSpec)
+        while($lastFetchedPage === null || $lastFetchedPage < $totalPages)
         {
-            $resources[] = $resourceClass::instantiateFromSpec($resourceSpec, $this);
+            $res = $this->api->get($this->createApiUrl(null, ['query' => ['page' => $nextPage]]));
+            $responseBody = \GuzzleHttp\json_decode($res->getBody());
+
+            foreach($responseBody->{$this->resourceNamePlural} as $resourceSpec)
+            {
+                $resources[] = $resourceClass::instantiateFromSpec($resourceSpec, $this);
+            }
+
+            // If this route doesn't support pagination, break out
+            if(!isset($responseBody->pagination)) break;
+
+            $lastFetchedPage = $nextPage;
+            $totalPages = $responseBody->pagination->total_pages;
+            $nextPage++;
         }
 
         return $resources;

diff --git a/src/API/RestfulKatapultApiV1/Resources/Organization/DNS/DnsZone.php b/src/API/RestfulKatapultApiV1/Resources/Organization/DNS/DnsZone.php
@@ -18,12 +18,14 @@ public static function getUrl($resourceId = null, $arguments = null)
     {
         if($resourceId)
         {
-            return "dns/zones/{$resourceId}";
+            $url = "dns/zones/{$resourceId}";
         }
         else
         {
             if(!is_array($arguments) || count($arguments) < 1) throw new \Exception('No arguments supplied to getUrl method');
-            return 'organizations/' . Helper::pluckObject($arguments, \Krystal\Katapult\Resources\Organization::class)->id . '/dns/zones';
+            $url = 'organizations/' . Helper::pluckObject($arguments, \Krystal\Katapult\Resources\Organization::class)->id . '/dns/zones';
         }
+
+        return \Krystal\Katapult\API\RestfulKatapultApiV1\Helper::addQueryToUrl($url, $arguments);
     }
 }
diff --git a/src/API/RestfulKatapultApiV1/Resources/Organization/ManagedOrganization.php b/src/API/RestfulKatapultApiV1/Resources/Organization/ManagedOrganization.php
@@ -22,7 +22,9 @@ public static function getUrl($resourceId = null, $arguments = null)
         else
         {
             if(!is_array($arguments) || count($arguments) < 1) throw new \Exception('No arguments supplied to getUrl method');
-            return 'organizations/' . Helper::pluckObject($arguments, Organization::class)->id . '/managed';
+            $url = 'organizations/' . Helper::pluckObject($arguments, Organization::class)->id . '/managed';
         }
+
+        return \Krystal\Katapult\API\RestfulKatapultApiV1\Helper::addQueryToUrl($url, $arguments);
     }
 }
diff --git a/src/API/RestfulKatapultApiV1/Resources/Organization/VirtualMachine.php b/src/API/RestfulKatapultApiV1/Resources/Organization/VirtualMachine.php
@@ -51,14 +51,14 @@ public static function getUrl($resourceId = null, $arguments = null)
                         break;
                 }
             }
-
-            return $url;
         }
         else
         {
             if(!is_array($arguments) || count($arguments) < 1) throw new \Exception('No arguments supplied to getUrl method');
-            return 'organizations/' . Helper::pluckObject($arguments, \Krystal\Katapult\Resources\Organization::class)->id . '/virtual_machines';
+            $url = 'organizations/' . Helper::pluckObject($arguments, \Krystal\Katapult\Resources\Organization::class)->id . '/virtual_machines';
         }
+
+        return \Krystal\Katapult\API\RestfulKatapultApiV1\Helper::addQueryToUrl($url, $arguments);
     }
 
     public static function callApiAction(ResourceController $resourceController, $action, $arguments)

diff --git a/src/API/RestfulKatapultApiV1/Resources/Organization/VirtualMachine/ConsoleSession.php b/src/API/RestfulKatapultApiV1/Resources/Organization/VirtualMachine/ConsoleSession.php
@@ -22,7 +22,9 @@ public static function getUrl($resourceId = null, $arguments = null)
         else
         {
             if(!is_array($arguments) || count($arguments) < 1) throw new \Exception('No arguments supplied to getUrl method');
-            return 'virtual_machines/' . Helper::pluckObject($arguments, VirtualMachine::class)->id . '/console_sessions';
+            $url = 'virtual_machines/' . Helper::pluckObject($arguments, VirtualMachine::class)->id . '/console_sessions';
         }
+
+        return \Krystal\Katapult\API\RestfulKatapultApiV1\Helper::addQueryToUrl($url, $arguments);
     }
 }
diff --git a/src/API/RestfulKatapultApiV1/Resources/Organization/VirtualMachine/VirtualMachineBuild.php b/src/API/RestfulKatapultApiV1/Resources/Organization/VirtualMachine/VirtualMachineBuild.php
@@ -17,11 +17,13 @@ public static function getUrl($resourceId = null, $arguments = null)
     {
         if($resourceId)
         {
-            return "virtual_machines/builds/{$resourceId}";
+            $url = "virtual_machines/builds/{$resourceId}";
         }
         else
         {
             throw new \Exception('VirtualMachineBuild does not support fetching a multiple resources');
         }
+
+        return \Krystal\Katapult\API\RestfulKatapultApiV1\Helper::addQueryToUrl($url, $arguments);
     }
 }
diff --git a/src/API/RestfulKatapultApiV1/Traits/HasStandardUrls.php b/src/API/RestfulKatapultApiV1/Traits/HasStandardUrls.php
@@ -2,11 +2,13 @@
 
 namespace Krystal\Katapult\API\RestfulKatapultApiV1\Traits;
 
+use Krystal\Katapult\API\RestfulKatapultApiV1\Helper;
+
 trait HasStandardUrls
 {
     public static function getUrl($resourceId = null, $arguments = null)
     {
-        if(!$resourceId) return self::getResourceName(true);
-        return self::getResourceName(true) . '/' . $resourceId;
+        $url = $resourceId ?  self::getResourceName(true) . '/' . $resourceId : self::getResourceName(true);
+        return Helper::addQueryToUrl($url, $arguments);
     }
 }