Merge pull request #32 from lokalise/feature/pagination_cursor_support

Add support for cursor based pagination
lokalise · May 23, 2024 · 5425280 · 5425280
2 parents 44dc830 + 4d192aa
commit 5425280
Show file tree

Hide file tree

Showing 24 changed files with 363 additions and 116 deletions.
diff --git a/Api/Endpoints/Comments.php b/Api/Endpoints/Comments.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Comments
@@ -46,7 +46,7 @@ public function listProject(string $projectId, array $queryParams = []): Lokalis
      */
     public function fetchAllProject(string $projectId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/comments",
             [],
@@ -89,7 +89,7 @@ public function listKey(string $projectId, int $keyId, array $queryParams = []):
      */
     public function fetchAllKey(string $projectId, int $keyId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/keys/$keyId/comments",
             [],

diff --git a/Api/Endpoints/Contributors.php b/Api/Endpoints/Contributors.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Contributors
@@ -46,7 +46,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/contributors",
             [],

diff --git a/Api/Endpoints/CustomTranslationStatuses.php b/Api/Endpoints/CustomTranslationStatuses.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class CustomTranslationStatuses
@@ -47,7 +47,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId, array $queryParams = []): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/custom-translation-statuses",
             $queryParams,

diff --git a/Api/Endpoints/Endpoint.php b/Api/Endpoints/Endpoint.php
@@ -110,6 +110,7 @@ protected function request(string $requestType, string $uri, array $queryParams
      *
      * @throws LokaliseApiException
      * @throws LokaliseResponseException
+     * @deprecated Use requestAllUsingCursor or requestAllUsingPaging instead
      */
     protected function requestAll(
         string $requestType,
@@ -118,12 +119,35 @@ protected function requestAll(
         array $body = [],
         string $bodyResponseKey = ''
     ): LokaliseApiResponse {
+        return $this->requestAllUsingPaging($requestType, $uri, $queryParams, $body, $bodyResponseKey);
+    }
+
+    /**
+     * @param string $requestType
+     * @param string $uri
+     * @param array $queryParams
+     * @param array $body
+     * @param string $bodyResponseKey
+     *
+     * @return LokaliseApiResponse
+     *
+     * @throws LokaliseApiException
+     * @throws LokaliseResponseException
+     */
+    protected function requestAllUsingPaging(
+        string $requestType,
+        string $uri,
+        array  $queryParams = [],
+        array  $body = [],
+        string $bodyResponseKey = ''
+    ): LokaliseApiResponse
+    {
         $page = 1;
         $queryParams = array_merge($queryParams, ['limit' => static::FETCH_ALL_LIMIT, 'page' => $page]);
 
         $bodyData = [];
         $result = $this->request($requestType, $uri, $queryParams, $body);
-        if (is_array($result->body[$bodyResponseKey])) {
+        if (isset($result->body[$bodyResponseKey]) && is_array($result->body[$bodyResponseKey])) {
             $bodyData = $result->body[$bodyResponseKey];
         }
         while ($result->getPageCount() > $page) {
@@ -134,14 +158,59 @@ protected function requestAll(
 
             $result = $this->request($requestType, $uri, $queryParams, $body);
             if (is_array($result->body[$bodyResponseKey])) {
-                $bodyData = array_merge($result->body[$bodyResponseKey], $bodyData);
+                $bodyData = array_merge($bodyData, $result->body[$bodyResponseKey]);
                 $result->body[$bodyResponseKey] = $bodyData;
             }
         }
 
         return $result;
     }
 
+
+    /**
+     * @param string $requestType
+     * @param string $uri
+     * @param array $queryParams
+     * @param array $body
+     * @param string $bodyResponseKey
+     *
+     * @return LokaliseApiResponse
+     *
+     * @throws LokaliseApiException
+     * @throws LokaliseResponseException
+     */
+    protected function requestAllUsingCursor(
+        string $requestType,
+        string $uri,
+        array  $queryParams = [],
+        array  $body = [],
+        string $bodyResponseKey = ''
+    ): LokaliseApiResponse
+    {
+        $bodyData = [];
+        $cursor = '';
+        $queryParams['limit'] = static::FETCH_ALL_LIMIT;
+        $queryParams['pagination'] = 'cursor';
+        while (true) {
+            $queryParams['cursor'] = $cursor;
+
+            $result = $this->request($requestType, $uri, $queryParams, $body);
+
+            if (is_array($result->body[$bodyResponseKey]) && !empty($result->body[$bodyResponseKey])) {
+                $bodyData = array_merge($bodyData, $result->body[$bodyResponseKey]);
+                $result->body[$bodyResponseKey] = $bodyData;
+            }
+
+            if (!$result->hasNextCursor()) {
+                break;
+            }
+
+            $cursor = $result->getNextCursor();
+        }
+
+        return $result;
+    }
+
     /**
      * @param array $queryParams
      *

diff --git a/Api/Endpoints/Files.php b/Api/Endpoints/Files.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Files
@@ -46,7 +46,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/files",
             [],

diff --git a/Api/Endpoints/Keys.php b/Api/Endpoints/Keys.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Keys
@@ -48,7 +48,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId, array $queryParams = []): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingCursor(
             'GET',
             "projects/$projectId/keys",
             $queryParams,

diff --git a/Api/Endpoints/Languages.php b/Api/Endpoints/Languages.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Languages
@@ -43,7 +43,7 @@ public function listSystem(array $queryParams = []): LokaliseApiResponse
      */
     public function fetchAllSystem(): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "system/languages",
             [],
@@ -84,7 +84,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/languages",
             [],

diff --git a/Api/Endpoints/Orders.php b/Api/Endpoints/Orders.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Orders
@@ -46,7 +46,7 @@ public function list(int $teamId, array $queryParams = []): LokaliseApiResponse
      */
     public function fetchAll(int $teamId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "teams/{$teamId}/orders",
             [],

diff --git a/Api/Endpoints/PaymentCards.php b/Api/Endpoints/PaymentCards.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Cards
@@ -43,7 +43,7 @@ public function list(array $queryParams = []): LokaliseApiResponse
      */
     public function fetchAll(): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "payment_cards",
             [],

diff --git a/Api/Endpoints/Projects.php b/Api/Endpoints/Projects.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Projects
@@ -45,7 +45,7 @@ public function list(array $queryParams = []): LokaliseApiResponse
      */
     public function fetchAll(array $queryParams = []): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects",
             $queryParams,

diff --git a/Api/Endpoints/Screenshots.php b/Api/Endpoints/Screenshots.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Screenshots
@@ -46,7 +46,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/screenshots",
             [],

diff --git a/Api/Endpoints/Snapshots.php b/Api/Endpoints/Snapshots.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Snapshots
@@ -46,7 +46,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/snapshots",
             [],

diff --git a/Api/Endpoints/Tasks.php b/Api/Endpoints/Tasks.php
@@ -2,9 +2,9 @@
 
 namespace Lokalise\Endpoints;
 
-use \Lokalise\LokaliseApiResponse;
-use \Lokalise\Exceptions\LokaliseApiException;
-use \Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\Exceptions\LokaliseApiException;
+use Lokalise\Exceptions\LokaliseResponseException;
+use Lokalise\LokaliseApiResponse;
 
 /**
  * Class Tasks
@@ -47,7 +47,7 @@ public function list(string $projectId, array $queryParams = []): LokaliseApiRes
      */
     public function fetchAll(string $projectId, array $queryParams = []): LokaliseApiResponse
     {
-        return $this->requestAll(
+        return $this->requestAllUsingPaging(
             'GET',
             "projects/$projectId/tasks",
             $queryParams,