Retrieving the next list items based on nextpagetoken flag

src/Api/ApigeeX/Controller/PaginationHelperTrait.php

@@ -25,7 +25,7 @@
 /**
  * Utility methods for those controllers that supports paginated listing.
  *
- * @see \Apigee\Edge\Api\ApigeeX\Controller\PaginatedEntityListingControllerInterface
+ * @see \PaginatedEntityListingControllerInterface
  */
 trait PaginationHelperTrait
 {
@@ -35,7 +35,7 @@ trait PaginationHelperTrait
     /**
      * {@inheritdoc}
      */
-    public function createPager(int $limit = 0, string $pageToken = null): PagerInterface
+    public function createPager(int $limit = 0, ?string $pageToken = null): PagerInterface
     {
         // Create an anonymous class here because this class should not exist and be in use
         // in those controllers that do not work with entities that belongs to an organization.
@@ -90,7 +90,7 @@ public function setLimit(int $limit): int
     /**
      * Loads paginated list of entities from Apigee X.
      *
-     * @param \Apigee\Edge\Api\ApigeeX\Structure\PagerInterface|null $pager
+     * @param \Structure\PagerInterface|null $pager
      *   Pager.
      * @param array $query_params
      *   Additional query parameters.
@@ -103,7 +103,7 @@ public function setLimit(int $limit): int
      * @psalm-suppress PossiblyNullArrayOffset $tmp->id() is always not null here.
      * @psalm-suppress PossiblyFalseArgument $tmp not be false.
      */
-    protected function listEntities(PagerInterface $pager = null, array $query_params = [], string $key_provider = 'id'): array
+    protected function listEntities(?PagerInterface $pager = null, array $query_params = [], string $key_provider = 'id'): array
     {
         if ($pager) {
             $responseArray = $this->getResultsInRange($pager, $query_params);
@@ -115,6 +115,8 @@ protected function listEntities(PagerInterface $pager = null, array $query_param
         } else {
             // Pass an empty pager to load all entities.
             $responseArray = $this->getResultsInRange($this->createPager(), $query_params);
+            // Check flag 'nextPageToken' to get next items from the list.
+            $nextPageToken = array_key_exists('nextPageToken', $responseArray) ? $responseArray['nextPageToken'] : false;
             // Ignore entity type key from response, ex.: developer, apiproduct,
             // etc.
             $responseArray = reset($responseArray);
@@ -123,30 +125,25 @@ protected function listEntities(PagerInterface $pager = null, array $query_param
                 return [];
             }
             $entities = $this->responseArrayToArrayOfEntities($responseArray, $key_provider);
-            $lastEntity = end($entities);
-            $lastId = $lastEntity->{$key_provider}();
-            do {
-                $tmp = $this->getResultsInRange($this->createPager(0, $lastId), $query_params);
-                // Ignore entity type key from response, ex.: developer,
-                // apiproduct, etc.
-                $tmp = reset($tmp);
-                // Remove the first item from the list because it is the same
-                // as the last item of $entities at this moment.
-                // Apigee X response always starts with the requested entity
-                // (pageToken).
-                array_shift($tmp);
-                $tmpEntities = $this->responseArrayToArrayOfEntities($tmp, $key_provider);
-
-                if (count($tmpEntities) > 0) {
+            if ($nextPageToken) {
+                do {
+                    $tmp = $this->getResultsInRange($this->createPager(0, $nextPageToken), $query_params);
+                    // Check the flag 'nextPageToken' to get next items from the list.
+                    $nextPageToken = array_key_exists('nextPageToken', $tmp) ? $tmp['nextPageToken'] : false;
+                    // Ignore entity type key from response, ex.: developer,
+                    // apiproduct, etc.
+                    $tmp = reset($tmp);
+                    // Remove the first item from the list because it is the same
+                    // as the last item of $entities at this moment.
+                    // Apigee X response always starts with the requested entity
+                    // (pageToken).
+                    array_shift($tmp);
+                    $tmpEntities = $this->responseArrayToArrayOfEntities($tmp, $key_provider);
                     // The returned entity array is keyed by entity id which
                     // is unique so we can do this.
                     $entities += $tmpEntities;
-                    $lastEntity = end($tmpEntities);
-                    $lastId = $lastEntity->{$key_provider}();
-                } else {
-                    $lastId = false;
-                }
-            } while ($lastId);
+                } while ($nextPageToken);
+            }
 
             return $entities;
         }
@@ -155,7 +152,7 @@ protected function listEntities(PagerInterface $pager = null, array $query_param
     /**
      * Gets entities and entity ids in a provided range from Apigee X.
      *
-     * @param \Apigee\Edge\Api\ApigeeX\Structure\PagerInterface $pager
+     * @param \Structure\PagerInterface $pager
      *   limit object with configured pageToken and limit.
      * @param array $query_params
      *   Query parameters for the API call.