Merge pull request #8 from rizkyarlin/pagination

#4 Allow Pagination

Author: LIQRGV

src/RequestParser.php

@@ -56,6 +56,7 @@ public function getBuilder(): Builder
 
         $builder = $this->applyFilter($model::query(), $modelBuilderStruct->filters);
         $builder = $this->applySorter($builder, $modelBuilderStruct->sorter);
+        $builder = $this->applyPaginator($builder, $modelBuilderStruct->paginator);
 
         return $builder;
     }
@@ -65,12 +66,15 @@ private function createModelBuilderStruct(Request $request): ModelBuilderStruct
         $queryParam = $request->query;
         $filterQuery = $queryParam->get('filter') ?? [];
         $sortQuery = $queryParam->get('sort') ?? null;
+        $limitQuery = $queryParam->get('limit') ?? null;
+        $offsetQuery = $queryParam->get('offset') ?? 0;
 
         $baseModelName = $this->getBaseModelName($request);
         $filters = $this->parseFilter($filterQuery);
         $sorter = $this->parseSorter($sortQuery);
+        $paginator = $this->parsePaginator($limitQuery, $offsetQuery);
 
-        return new ModelBuilderStruct($baseModelName, $filters, $sorter);
+        return new ModelBuilderStruct($baseModelName, $filters, $sorter, $paginator);
     }
 
     private function getBaseModelName(Request $request): string
@@ -156,6 +160,13 @@ private function parseSorter(?string $sortQuery): ?array
         return $sortStructs;
     }
 
+    private function parsePaginator($limitQuery, $offsetQuery){
+        return [
+            "limit" => $limitQuery,
+            "offset" => $offsetQuery
+        ];
+    }
+
     private function getModelFromNamespaces(string $modelName, array $modelNamespaces)
     {
         foreach ($modelNamespaces as $modelNamespace) {
@@ -193,6 +204,14 @@ private function applySorter(Builder $builder, array $sorter)
         return $builder;
     }
 
+    private function applyPaginator(Builder $builder, array $paginator): Builder
+    {
+        if ($paginator['limit']){
+            return $builder->limit($paginator['limit'])->offset($paginator['offset']);
+        }
+        return $builder;
+    }
+
     private function createModel(string $baseModelName)
     {
         $model = new $baseModelName;

src/Struct/ModelBuilderStruct.php

@@ -16,10 +16,15 @@ class ModelBuilderStruct {
      * @var SortStruct
      */
     public $sorter;
+    /**
+     * @var array
+     */
+    public $paginator;
 
-    public function __construct(string $baseModelName, array $filters, array $sorter) {
+    public function __construct(string $baseModelName, array $filters, array $sorter, array $paginator) {
         $this->baseModelName = $baseModelName;
         $this->filters = $filters;
         $this->sorter = $sorter;
+        $this->paginator = $paginator;
     }
 }

tests/RequestParserTest.php

@@ -404,4 +404,75 @@ function testFilterWithOrUsingBetweenQueryKeyword()
             $builder->getBindings()
         );
     }
+
+    function testPagination()
+    {
+        $uri = 'some_model';
+        $controllerClass = MockModelController::class;
+        $query = new ParameterBag([
+            "limit" => "100",
+            "offset" => "50"
+        ]);
+        $requestParserOptions = [
+            'model_namespaces' => [
+                'LIQRGV\QueryFilter\Mocks',
+            ]
+        ];
+
+        $request = $this->createControllerRequest($uri, $controllerClass, $query, $requestParserOptions);
+
+        $requestParser = new RequestParser($request);
+        $builder = $requestParser->getBuilder();
+
+        $query = $builder->getQuery();
+        $this->assertEquals("mock_models", $query->from);
+        $this->assertEquals(100, $query->limit);
+        $this->assertEquals(50, $query->offset);
+    }
+
+    function testPaginationIgnoreOffset(){
+        $uri = 'some_model';
+        $controllerClass = MockModelController::class;
+        $query = new ParameterBag([
+            "offset" => "50"
+        ]);
+        $requestParserOptions = [
+            'model_namespaces' => [
+                'LIQRGV\QueryFilter\Mocks',
+            ]
+        ];
+
+        $request = $this->createControllerRequest($uri, $controllerClass, $query, $requestParserOptions);
+
+        $requestParser = new RequestParser($request);
+        $builder = $requestParser->getBuilder();
+
+        $query = $builder->getQuery();
+        $this->assertEquals("mock_models", $query->from);
+        $this->assertNull($query->limit);
+        $this->assertNull($query->offset);
+    }
+
+    function testPaginationUsingZeroAsDefaultOffset(){
+        $uri = 'some_model';
+        $controllerClass = MockModelController::class;
+        $query = new ParameterBag([
+            "limit" => "50"
+        ]);
+        $requestParserOptions = [
+            'model_namespaces' => [
+                'LIQRGV\QueryFilter\Mocks',
+            ]
+        ];
+
+        $request = $this->createControllerRequest($uri, $controllerClass, $query, $requestParserOptions);
+
+        $requestParser = new RequestParser($request);
+        $builder = $requestParser->getBuilder();
+
+        $query = $builder->getQuery();
+        $this->assertEquals("mock_models", $query->from);
+        $this->assertEquals(50, $query->limit);
+        $this->assertEquals(0, $query->offset);
+    }
 }