Implemented #504

Author: mevdschee

src/Tqdev/PhpCrudApi/Api.php

@@ -17,6 +17,7 @@
 use Tqdev\PhpCrudApi\Middleware\FirewallMiddleware;
 use Tqdev\PhpCrudApi\Middleware\JwtAuthMiddleware;
 use Tqdev\PhpCrudApi\Middleware\MultiTenancyMiddleware;
+use Tqdev\PhpCrudApi\Middleware\PageLimitsMiddleware;
 use Tqdev\PhpCrudApi\Middleware\Router\SimpleRouter;
 use Tqdev\PhpCrudApi\Middleware\SanitationMiddleware;
 use Tqdev\PhpCrudApi\Middleware\ValidationMiddleware;
@@ -74,6 +75,9 @@ public function __construct(Config $config)
                 case 'xsrf':
                     new XsrfMiddleware($router, $responder, $properties);
                     break;
+                case 'pageLimits':
+                    new PageLimitsMiddleware($router, $responder, $properties, $reflection);
+                    break;
                 case 'customization':
                     new CustomizationMiddleware($router, $responder, $properties, $reflection);
                     break;

src/Tqdev/PhpCrudApi/Record/PaginationInfo.php

@@ -25,7 +25,7 @@ public function getPageOffset(array $params): int
         return $offset;
     }
 
-    public function getPageSize(array $params): int
+    private function getPageSize(array $params): int
     {
         $pageSize = $this->DEFAULT_PAGE_SIZE;
         if (isset($params['page'])) {
@@ -50,4 +50,21 @@ public function getResultSize(array $params): int
         return $numberOfRows;
     }
 
+    public function getPageLimit(array $params): int
+    {
+        $pageLimit = -1;
+        if ($this->hasPage($params)) {
+            $pageLimit = $this->getPageSize($params);
+        }
+        $resultSize = $this->getResultSize($params);
+        if ($resultSize >= 0) {
+            if ($pageLimit >= 0) {
+                $pageLimit = min($pageLimit, $resultSize);
+            } else {
+                $pageLimit = $resultSize;
+            }
+        }
+        return $pageLimit;
+    }
+
 }

src/Tqdev/PhpCrudApi/Record/RecordService.php

@@ -108,11 +108,11 @@ public function _list(String $tableName, array $params): ListDocument
         $columnOrdering = $this->ordering->getColumnOrdering($table, $params);
         if (!$this->pagination->hasPage($params)) {
             $offset = 0;
-            $limit = $this->pagination->getResultSize($params);
+            $limit = $this->pagination->getPageLimit($params);
             $count = 0;
         } else {
             $offset = $this->pagination->getPageOffset($params);
-            $limit = $this->pagination->getPageSize($params);
+            $limit = $this->pagination->getPageLimit($params);
             $count = $this->db->selectCount($table, $condition);
         }
         $records = $this->db->selectAll($table, $columnNames, $condition, $columnOrdering, $offset, $limit);

src/Tqdev/PhpCrudApi/Request.php

@@ -128,6 +128,11 @@ public function getParams(): array
         return $this->params;
     }
 
+    public function setParams(array $params) /*: void*/
+    {
+        $this->params = $params;
+    }
+
     public function getBody() /*: ?array*/
     {
         return $this->body;

tests/config/base.php

@@ -4,7 +4,7 @@
     'username' => 'php-crud-api',
     'password' => 'php-crud-api',
     'controllers' => 'records,columns,cache,openapi',
-    'middlewares' => 'cors,jwtAuth,basicAuth,authorization,validation,sanitation,multiTenancy,customization',
+    'middlewares' => 'cors,jwtAuth,basicAuth,authorization,validation,sanitation,multiTenancy,pageLimits,customization',
     'jwtAuth.mode' => 'optional',
     'jwtAuth.time' => '1538207605',
     'jwtAuth.secret' => 'axpIrCGNGqxzx2R9dtXLIPUSqPo778uhb8CA0F4Hx',
@@ -28,6 +28,8 @@
     'multiTenancy.handler' => function ($operation, $tableName) {
         return ($tableName == 'kunsthåndværk') ? ['user_id' => 1] : [];
     },
+    'pageLimits.pages' => 5,
+    'pageLimits.records' => 10,
     'customization.beforeHandler' => function ($operation, $tableName, $request, $environment) {
         $environment->start = 0.003/*microtime(true)*/;
     },

tests/functional/001_records/077_list_posts_with_page_limits.log

@@ -0,0 +1,31 @@
+GET /records/posts?size=10
+===
+200
+Content-Type: application/json
+Content-Length: 690
+
+{"records":[{"id":1,"user_id":1,"category_id":1,"content":"blog started"},{"id":2,"user_id":1,"category_id":2,"content":"🦀€ Grüßgott, Вiтаю, dobrý deň, hyvää päivää, გამარჯობა, Γεια σας, góðan dag, здравствуйте"},{"id":5,"user_id":1,"category_id":1,"content":"#1"},{"id":6,"user_id":1,"category_id":1,"content":"#2"},{"id":7,"user_id":1,"category_id":1,"content":"#3"},{"id":8,"user_id":1,"category_id":1,"content":"#4"},{"id":9,"user_id":1,"category_id":1,"content":"#5"},{"id":10,"user_id":1,"category_id":1,"content":"#6"},{"id":11,"user_id":1,"category_id":1,"content":"#7"},{"id":12,"user_id":1,"category_id":1,"content":"#8"}]}
+===
+GET /records/posts
+===
+200
+Content-Type: application/json
+Content-Length: 690
+
+{"records":[{"id":1,"user_id":1,"category_id":1,"content":"blog started"},{"id":2,"user_id":1,"category_id":2,"content":"🦀€ Grüßgott, Вiтаю, dobrý deň, hyvää päivää, გამარჯობა, Γεια σας, góðan dag, здравствуйте"},{"id":5,"user_id":1,"category_id":1,"content":"#1"},{"id":6,"user_id":1,"category_id":1,"content":"#2"},{"id":7,"user_id":1,"category_id":1,"content":"#3"},{"id":8,"user_id":1,"category_id":1,"content":"#4"},{"id":9,"user_id":1,"category_id":1,"content":"#5"},{"id":10,"user_id":1,"category_id":1,"content":"#6"},{"id":11,"user_id":1,"category_id":1,"content":"#7"},{"id":12,"user_id":1,"category_id":1,"content":"#8"}]}
+===
+GET /records/posts?page=5,1
+===
+200
+Content-Type: application/json
+Content-Length: 78
+
+{"records":[{"id":7,"user_id":1,"category_id":1,"content":"#3"}],"results":12}
+===
+GET /records/posts?page=6,1
+===
+200
+Content-Type: application/json
+Content-Length: 78
+
+{"records":[{"id":7,"user_id":1,"category_id":1,"content":"#3"}],"results":12}