Fixes #443

Author: mevdschee

README.md

@@ -695,6 +695,19 @@ If your tenants are identified by the "customer_id" column you can use the follo
 This construct adds a filter requiring "customer_id" to be "12" to every operation (except for "create").
 It also sets the column "customer_id" on "create" to "12" and removes the column from any other write operation.
 
+### Custom handlers
+
+You may use the "custom" middleware to implement any other functionality.
+
+    'custom.beforeHandler' => function ($operation, $tableName, $request, $environment) {
+        $environment->start = microtime(true);
+    },
+    'custom.afterHandler' => function ($operation, $tableName, $response, $environment) {
+        $response->addHeader('X-Time-Taken', microtime(true) - $environment->start);
+    },
+
+The above example will add a header "X-Time-Taken" with the number of seconds the API call has taken.
+
 ## OpenAPI specification
 
 On the "/openapi" end-point the OpenAPI 3.0 (formerly called "Swagger") specification is served. 

src/Tqdev/PhpCrudApi/Api.php

@@ -13,6 +13,7 @@
 use Tqdev\PhpCrudApi\Middleware\AuthorizationMiddleware;
 use Tqdev\PhpCrudApi\Middleware\BasicAuthMiddleware;
 use Tqdev\PhpCrudApi\Middleware\CorsMiddleware;
+use Tqdev\PhpCrudApi\Middleware\CustomMiddleware;
 use Tqdev\PhpCrudApi\Middleware\FirewallMiddleware;
 use Tqdev\PhpCrudApi\Middleware\JwtAuthMiddleware;
 use Tqdev\PhpCrudApi\Middleware\MultiTenancyMiddleware;
@@ -69,6 +70,9 @@ public function __construct(Config $config)
                 case 'authorization':
                     new AuthorizationMiddleware($router, $responder, $properties, $reflection);
                     break;
+                case 'custom':
+                    new CustomMiddleware($router, $responder, $properties, $reflection);
+                    break;
             }
         }
         foreach ($config->getControllers() as $controller) {

src/Tqdev/PhpCrudApi/Middleware/CustomMiddleware.php

@@ -0,0 +1,39 @@
+<?php
+namespace Tqdev\PhpCrudApi\Middleware;
+
+use Tqdev\PhpCrudApi\Column\ReflectionService;
+use Tqdev\PhpCrudApi\Controller\Responder;
+use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
+use Tqdev\PhpCrudApi\Middleware\Router\Router;
+use Tqdev\PhpCrudApi\Record\RequestUtils;
+use Tqdev\PhpCrudApi\Request;
+use Tqdev\PhpCrudApi\Response;
+
+class CustomMiddleware extends Middleware
+{
+    private $reflection;
+
+    public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
+    {
+        parent::__construct($router, $responder, $properties);
+        $this->reflection = $reflection;
+        $this->utils = new RequestUtils($reflection);
+    }
+
+    public function handle(Request $request): Response
+    {
+        $operation = $this->utils->getOperation($request);
+        $tableName = $request->getPathSegment(2);
+        $beforeHandler = $this->getProperty('beforeHandler', '');
+        $environment = (object) array();
+        if ($beforeHandler !== '') {
+            call_user_func($beforeHandler, $operation, $tableName, $request, $environment);
+        }
+        $response = $this->next->handle($request);
+        $afterHandler = $this->getProperty('afterHandler', '');
+        if ($afterHandler !== '') {
+            call_user_func($afterHandler, $operation, $tableName, $response, $environment);
+        }
+        return $response;
+    }
+}

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',
+    'middlewares' => 'cors,jwtAuth,basicAuth,authorization,validation,sanitation,multiTenancy,custom',
     'jwtAuth.time' => '1538207605',
     'jwtAuth.secret' => 'axpIrCGNGqxzx2R9dtXLIPUSqPo778uhb8CA0F4Hx',
     'basicAuth.passwordFile' => __DIR__ . DIRECTORY_SEPARATOR . '.htpasswd',
@@ -26,5 +26,13 @@
     'multiTenancy.handler' => function ($operation, $tableName) {
         return ($tableName == 'kunsthåndværk') ? ['user_id' => 1] : [];
     },
+    'custom.beforeHandler' => function ($operation, $tableName, $request, $environment) {
+        $environment->start = 0.003/*microtime(true)*/;
+    },
+    'custom.afterHandler' => function ($operation, $tableName, $response, $environment) {
+        if ($tableName == 'kunsthåndværk' && $operation == 'increment') {
+            $response->addHeader('X-Time-Taken', 0.006/*microtime(true)*/ - $environment->start);
+        }
+    },
     'debug' => true,
 ];

tests/functional/001_records/074_custom_kunsthåndværk.log

@@ -0,0 +1,21 @@
+PATCH /records/kunsthåndværk/e42c77c6-06a4-4502-816c-d112c7142e6d
+
+{"Umlauts ä_ö_ü-COUNT":10}
+===
+200
+Content-Type: application/json
+Content-Length: 1
+X-Time-Taken: 0.003
+
+1
+===
+PATCH /records/kunsthåndværk/e42c77c6-06a4-4502-816c-d112c7142e6d
+
+{"Umlauts ä_ö_ü-COUNT":-10}
+===
+200
+Content-Type: application/json
+Content-Length: 1
+X-Time-Taken: 0.003
+
+1