chore: filter, pagination and limit in filter function

Author: fullstackondemand

composer.json

@@ -20,7 +20,8 @@
     "license": "MIT",
     "autoload": {
         "files": [
-            "src/function.php"
+            "src/function.php",
+            "src/filter.php"
         ],
         "psr-4": {
             "RestJS\\": "src/"

src/Controller/AbstractController.php

@@ -3,7 +3,7 @@
 namespace RestJS\Controller;
 
 use RestJS\Message\Response;
-use function RestJS\response;
+use function RestJS\response, RestJS\filter;
 use Slim\Exception\HttpBadRequestException;
 
 /** Abstract Controller Functions */
@@ -18,20 +18,26 @@ public function __construct($model) {
 
     /** Find All Data */
     public function findAll($req, $res) {
-        return response($req, $res, new Response(data: $this->_model->findAll()));
+        $data = filter($this->_model->findAll(), $req);
+        return response($req, $res, new Response(data: $data));
     }
 
-    /** Find Data by Column */
+    /** Find Data by Conditional */
     public function findByColumn($req, $res, $args) {
-        $data = $this->_model->findBy($args);
-        return response($req, $res, args: new Response(data: [...$data]));
+        $data = filter($this->_model->findBy($args), $req);
+        return response($req, $res, args: new Response(data: $data));
+    }
+
+    /** Filter Data by Conditional */
+    public function filter($req, $res, $args) {
+        return response($req, $res, args: new Response(data: $this->_model->filter($args)));
     }
 
     /** Delete Data by Id */
     public function delete($req, $res, $args) {
         $data = $this->_model->delete($args);
 
-        // Check data is deleted
+        // Check Data is Deleted
         if (!$data)
             throw new HttpBadRequestException($req, "Something went wrong...");
 
@@ -41,7 +47,7 @@ public function delete($req, $res, $args) {
     /** Insert Data */
     public function insert($req, $res, $args) {
 
-        // Check user input valid form data
+        // Check User Input Valid Form Data
         if(!$req->getParsedBody())
             throw new HttpBadRequestException($req, "Please enter valid form data.");
 
@@ -52,13 +58,13 @@ public function insert($req, $res, $args) {
     /** Update by Id */
     public function update($req, $res, $args) {
 
-        // check user input valid form data
+        // Check User Input Valid Form Data
         if (!$req->getParsedBody())
             throw new HttpBadRequestException($req, "Please enter valid form data.");
 
         $data = $this->_model->update($req->getParsedBody(), $args);
 
-        // Check data is updated
+        // Check Data is Updated
         if (!$data)
             throw new HttpBadRequestException($req, "Something went wrong...");
 

src/api/category/router.php

@@ -8,7 +8,7 @@
 class Router {
     public function __invoke(RouteCollectorProxy $router) {
         $router->get('/', [Controller::class, "findAll"]);
-        $router->get('/{id:[0-9]+}/', [Controller::class, "findByColumn"]);
-        $router->get('/{slug:[a-z0-9-]+}/', [Controller::class, "findByColumn"]);
+        $router->get('/{id:[0-9]+}/', [Controller::class, "filter"]);
+        $router->get('/{slug:[a-z0-9-]+}/', [Controller::class, "filter"]);
     }
 }

src/api/user/router.php

@@ -9,12 +9,12 @@
 class Router {
     public function __invoke(RouteCollectorProxy $router) {
         $router->get('/', [Controller::class, "findAll"]);
-        $router->get('/{id:[0-9]+}/', [Controller::class, "findByColumn"]);
-        $router->get('/{username:[a-z0-9-]+}/', [Controller::class, "findByColumn"]);
+        $router->get('/{id:[0-9]+}/', [Controller::class, "filter"]);
+        $router->get('/{username:[a-z0-9-]+}/', [Controller::class, "filter"]);
 
         // Category Route
         $router->get('/{userId:[0-9]+}/categories/', [CategoryController::class, "findByColumn"]);
-        $router->get('/{userId:[0-9]+}/categories/{id:[0-9]+}/', [CategoryController::class, "findByColumn"]);
+        $router->get('/{userId:[0-9]+}/categories/{id:[0-9]+}/', [CategoryController::class, "filter"]);
         $router->post('/{userId:[0-9]+}/categories/', [CategoryController::class, "insert"]);
         $router->put('/{userId:[0-9]+}/categories/{id:[0-9]+}/', [CategoryController::class, "update"]);
         $router->delete('/{userId:[0-9]+}/categories/{id:[0-9]+}/', [CategoryController::class, "delete"]);

src/filter.php

@@ -0,0 +1,47 @@
+<?php
+declare(strict_types=1);
+namespace RestJS;
+
+use Psr\Http\Message\ServerRequestInterface as Request;
+
+/** Filter Function for Response Data Manipulation */
+function filter($data, Request $req): array {
+
+    // Get Query Params Values
+    extract($req->getQueryParams() ?? []);
+
+    /** After Filter Data */
+    $filterData = [];
+
+    /** Filter Column Query Params */
+    $filter ??= null;
+
+    /** Pagination Page Number Query Params */
+    $page ??= 1;
+
+    /** Per Page Limit Query Params */
+    $limit ??= 10;
+
+    // Selected Column Fetch All Data
+    if ($filter):
+        $filter = explode(",", $filter);
+
+        foreach ($data as $item)
+            array_push($filterData, array_intersect_key((array) $item, array_flip($filter)));
+    endif;
+
+    // According Pagination Fetch All Data
+    if ($page):
+        $filter && $data = $filterData;
+        $filterData = array_slice($data, $page == 1 ? 0 : $limit * ($page - 1), (int) $limit);
+    endif;
+
+    return [
+        "page" => $page,
+        "limit" => $limit,
+        "totalPages" => ceil(count($data) / $limit),
+        "totalItems" => count($data),
+        "currentPageItems" => count($filterData),
+        'data' => $filterData,
+    ];
+}