Merge pull request #163 from 5pm-HDH/feat/160/pagination-page-size

feat(pagination): set page-size option #160

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Add SongStatistic ([PR140](https://github.com/5pm-HDH/churchtools-api/pull/140))
 - Add multi-factor authentication support ([PR146](https://github.com/5pm-HDH/churchtools-api/pull/146))
 - Group-member-fields and DBFields-API ([PR147](https://github.com/5pm-HDH/churchtools-api/issues/147))
+- Pagination Page-Size Option ([PR163](https://github.com/5pm-HDH/churchtools-api/pull/163))
 
 ### Changed
 - Authenticate CTClient with session cookie instead of api-key ([PR142](https://github.com/5pm-HDH/churchtools-api/pull/142))

README.md

@@ -56,9 +56,10 @@ From now on all features of the ChurchTools-API are available.
 
 ### Requests and Models
 
-The whole ChurchTools-API client is build on top of the Requests and Models. [Requests](/docs/out/Requests.md) provide
-an interface to specify your api call by adding filtering, pagination and sorting. [Models](/docs/out/Models.md)
-represent the data, that the Requests retrieve. More informations can be found in the documentation.
+The whole ChurchTools-API client is build on top of the Requests and Models. Requests provide an interface to specify your api call by adding filtering, pagination and sorting. Models represent the data, that the Requests retrieve. More informations can be found in the documentation: 
+
+* [Requests](/docs/out/Requests.md)
+* [Models](/docs/out/Models.md)
 
 All APIs with examples:
 

docs/out/CTConfig.md

@@ -137,7 +137,18 @@ $response = $client->get(
 
 ```
 
-## 4. CSRF-Token
+## 4. Pagination
+
+Set Page-Size of Pagination-Requests.
+
+```php
+use CTApi\CTConfig;
+
+CTConfig::setPaginationPageSize(400);
+
+```
+
+## 5. CSRF-Token
 
 ```php
         use CTApi\Requests\CSRFTokenRequest;

docs/out/Requests.md

@@ -69,6 +69,15 @@ Iterating over all records is quite easy.
 
 ```
 
+If you want to set the Pagination Page-Size for all Requests you can use the CTConfig.
+
+```php
+use CTApi\CTConfig;
+
+CTConfig::setPaginationPageSize(400);
+
+```
+
 **Get single record**
 
 The `find`-method returns the Model. If there is no record with the given id, it will return null. The `findOrFail`

docs/src/ressources/CTConfig.md

@@ -128,6 +128,16 @@ $response = $client->get(
             );
 ```
 
-## 4. CSRF-Token
+## 4. Pagination
+
+Set Page-Size of Pagination-Requests.
+
+```php
+use CTApi\CTConfig;
+
+CTConfig::setPaginationPageSize(400);
+```
+
+## 5. CSRF-Token
 
 {{ \Tests\Unit\Docs\CSRFTokenRequestTest.testGetCSRFToken }}

docs/src/ressources/Requests.md

@@ -31,6 +31,14 @@ Iterating over all records is quite easy.
 
 {{ \Tests\Unit\Docs\PaginationTest.testIteratePages }}
 
+If you want to set the Pagination Page-Size for all Requests you can use the CTConfig.
+
+```php
+use CTApi\CTConfig;
+
+CTConfig::setPaginationPageSize(400);
+```
+
 **Get single record**
 
 The `find`-method returns the Model. If there is no record with the given id, it will return null. The `findOrFail`

src/CTConfig.php

@@ -32,6 +32,8 @@ class CTConfig
      */
     private array $requestOptions;
 
+    private ?int $paginationPageSize = null;
+
     private function __construct()
     {
         $this->cookieJar = new CookieJar();
@@ -143,6 +145,18 @@ public static function getApiKey(): ?string
         return self::getRequestOption(self::PATH_LOGIN_TOKEN);
     }
 
+    public static function setPaginationPageSize(int $pageSize): void
+    {
+        self::getConfig()->paginationPageSize = $pageSize;
+    }
+
+    public static function getPaginationPageSize(): ?int
+    {
+        $config = self::getConfig();
+        $size = $config->paginationPageSize;
+        return $size;
+    }
+
     public static function validateConfig(): void
     {
         $apiUrl = self::getRequestOption('base_uri');

src/Requests/Traits/Pagination.php

@@ -3,6 +3,7 @@
 namespace CTApi\Requests\Traits;
 
 use CTApi\CTClient;
+use CTApi\CTConfig;
 use CTApi\Utils\CTResponseUtil;
 
 trait Pagination
@@ -26,6 +27,7 @@ protected function collectDataFromPages(string $url, array $options = []): array
         }
 
         //Collect Data from First Page
+        $this->addPaginationPageSizeIfNotExists($options);
         $response = $client->get($url, $options);
 
         $metaInformation = CTResponseUtil::metaAsArray($response);
@@ -47,4 +49,11 @@ protected function collectDataFromPages(string $url, array $options = []): array
 
         return $collectedData;
     }
+
+    private function addPaginationPageSizeIfNotExists(&$options)
+    {
+        if (CTConfig::getPaginationPageSize() != null && !array_key_exists("limit", $options["query"])) {
+            $options["query"]["limit"] = CTConfig::getPaginationPageSize();
+        }
+    }
 }

tests/unit/Requests/PaginationTest.php

@@ -0,0 +1,51 @@
+<?php
+
+
+namespace Tests\Unit\Requests;
+
+
+use CTApi\CTClient;
+use CTApi\CTConfig;
+use CTApi\Requests\EventRequest;
+use CTApi\Requests\PersonRequest;
+use Tests\Unit\HttpMock\CTClientMock;
+use Tests\Unit\TestCaseHttpMocked;
+
+class PaginationTest extends TestCaseHttpMocked
+{
+
+    public function testPagination()
+    {
+        CTConfig::setPaginationPageSize(6);
+        EventRequest::all();
+        $this->assertAllRequestContainLimit(6);
+    }
+
+    public function testManualPagination()
+    {
+        EventRequest::where("limit", 9)->get();
+        $this->assertAllRequestContainLimit(9);
+    }
+
+    public function testOverrideManualPagination()
+    {
+        CTConfig::setPaginationPageSize(12);
+        EventRequest::where("limit", 9)->get();
+        $this->assertAllRequestContainLimit(9);
+    }
+
+    private function assertAllRequestContainLimit(?int $pageSize)
+    {
+        foreach ($this->getClientMock()->getAllRequestCalls() as $requestCall) {
+            $this->assertRequestContainsLimit($requestCall, $pageSize);
+        }
+    }
+
+    private function assertRequestContainsLimit(array $request, ?int $pageSize)
+    {
+        $this->assertArrayHasKey("options", $request);
+        $this->assertArrayHasKey("query", $request["options"]);
+        $this->assertArrayHasKey("limit", $request["options"]["query"]);
+        $this->assertEquals($pageSize, $request["options"]["query"]["limit"]);
+    }
+}

tests/unit/TestCaseHttpMocked.php

@@ -4,12 +4,13 @@
 
 use CTApi\CTClient;
 use CTApi\CTConfig;
+use CTApi\Utils\CTUtil;
 use PHPUnit\Framework\TestCase;
 use Tests\Unit\HttpMock\CTClientMock;
 
 class TestCaseHttpMocked extends TestCase
 {
-    private $ctClientMock;
+    private CTClientMock $ctClientMock;
 
     protected function setUp(): void
     {
@@ -22,11 +23,17 @@ protected function setUp(): void
         CTClient::setClient($this->ctClientMock);
     }
 
-    protected function setClientMock(CTClientMock $clientMock){
+    protected function setClientMock(CTClientMock $clientMock)
+    {
         $this->ctClientMock = $clientMock;
         CTClient::setClient($this->ctClientMock);
     }
 
+    protected function getClientMock(): CTClientMock
+    {
+        return $this->ctClientMock;
+    }
+
     protected function assertRequestCallExists(string $method, $uri = null): array
     {
         return $this->ctClientMock->assertRequestCallExists($method, $uri);