Add handlers for HEAD and PATCH methods in routes and pipes

Author: na2axl

src/WaterPipe/Routing/Route.php

@@ -105,4 +105,16 @@ public abstract function put();
      * is sent to this route.
      */
     public abstract function delete();
+
+    /**
+     * Execute an action when a HEAD request method
+     * is sent to this route.
+     */
+    public abstract function head();
+
+    /**
+     * Execute an action when a PATCH request method
+     * is sent to this route.
+     */
+    public abstract function patch();
 }

src/WaterPipe/WaterPipe.php

@@ -41,6 +41,7 @@
 use ElementaryFramework\WaterPipe\Routing\Middleware\Middleware;
 use ElementaryFramework\WaterPipe\Routing\Route;
 use ElementaryFramework\WaterPipe\Routing\RouteAction;
+use ElementaryFramework\WaterPipe\Routing\RouteMap;
 
 class WaterPipe
 {
@@ -101,6 +102,20 @@ class WaterPipe
      */
     private $_deleteRequestRegistry;
 
+    /**
+     * The array of registered head requests.
+     *
+     * @var callable[]
+     */
+    private $_headRequestRegistry;
+
+    /**
+     * The array of registered patch requests.
+     *
+     * @var callable[]
+     */
+    private $_patchRequestRegistry;
+
     /**
      * The array of registered requests.
      *
@@ -123,6 +138,13 @@ class WaterPipe
      */
     private $_pipesRegistry;
 
+    /**
+     * The array of route maps.
+     *
+     * @var RouteMap[]
+     */
+    private $_mapRegistry;
+
     /**
      * @return WaterPipe
      */
@@ -168,9 +190,12 @@ public function __construct()
         $this->_postRequestRegistry = array();
         $this->_putRequestRegistry = array();
         $this->_deleteRequestRegistry = array();
+        $this->_headRequestRegistry = array();
+        $this->_patchRequestRegistry = array();
         $this->_requestRegistry = array();
         $this->_errorsRegistry = array();
         $this->_pipesRegistry = array();
+        $this->_mapRegistry = array();
     }
 
     /**
@@ -184,7 +209,7 @@ public function use($plugin)
         if ($plugin instanceof Middleware) {
             array_push($this->_middlewareRegistry, $plugin);
         } elseif ($plugin instanceof Route) {
-            foreach (array("request", "get", "post", "put", "delete") as $method) {
+            foreach (array("request", "get", "post", "put", "delete", "head", "patch") as $method) {
                 $this->$method($plugin->getUri(), array($plugin, $method));
             }
         } elseif ($plugin instanceof WaterPipe) {
@@ -194,7 +219,9 @@ public function use($plugin)
                          "post" => $plugin->_postRequestRegistry,
                          "put" => $plugin->_putRequestRegistry,
                          "error" => $plugin->_errorsRegistry,
-                         "delete" => $plugin->_deleteRequestRegistry) as $method => $registry) {
+                         "delete" => $plugin->_deleteRequestRegistry,
+                         "head" => $plugin->_headRequestRegistry,
+                         "patch" => $plugin->_patchRequestRegistry) as $method => $registry) {
 
                 foreach ($registry as $uri => $action) {
                     $this->$method($uri, $action);
@@ -204,6 +231,11 @@ public function use($plugin)
         }
     }
 
+    public function map(string $baseUri, RouteMap $routeMap)
+    {
+        $this->_mapRegistry[$baseUri] = $routeMap;
+    }
+
     /**
      * Register a request handled by this pipe.
      *
@@ -264,6 +296,30 @@ public function delete(string $uri, $action)
         $this->_deleteRequestRegistry[$uri] = $action;
     }
 
+    /**
+     * Register a HEAD request handled by this pipe.
+     *
+     * @param string   $uri    The request URI.
+     * @param callable $action The action to call when the request
+     *                         correspond to the given  URI.
+     */
+    public function head(string $uri, $action)
+    {
+        $this->_headRequestRegistry[$uri] = $action;
+    }
+
+    /**
+     * Register a PATCH request handled by this pipe.
+     *
+     * @param string   $uri    The request URI.
+     * @param callable $action The action to call when the request
+     *                         correspond to the given  URI.
+     */
+    public function patch(string $uri, $action)
+    {
+        $this->_patchRequestRegistry[$uri] = $action;
+    }
+
     /**
      * Register a sub pipe managed by this pipe.
      *
@@ -346,6 +402,20 @@ private function _findSubPipe()
         return null;
     }
 
+    /**
+     * @return array|null
+     */
+    private function _findRouteMap()
+    {
+        foreach ($this->_mapRegistry as $baseUri => &$map) {
+            if (preg_match("#^" . RequestUri::makeUri($this->_baseUri, RequestUri::pattern2regex($baseUri)) . "#", Request::capture()->uri->getUri())) {
+                return array(RequestUri::makeUri($this->_baseUri, $baseUri), $map);
+            }
+        }
+
+        return null;
+    }
+
     /**
      * Executes the request.
      */
@@ -355,6 +425,13 @@ private function _executeRequest()
             // Execute middleware
             self::triggerBeforeExecuteEvent(Request::capture());
 
+            $map = $this->_findRouteMap();
+
+            if ($map !== null) {
+                $uri = str_replace('/' . trim($map[0], "/ ") . '/', '', '/' . ltrim(Request::capture()->uri->getUri(), "/ "));
+                $map[1]->map($uri);
+            }
+
             $registry = null;
 
             switch (Request::capture()->getMethod()) {
@@ -378,6 +455,14 @@ private function _executeRequest()
                 case RequestMethod::DELETE:
                     $registry = $this->_deleteRequestRegistry;
                     break;
+
+                case RequestMethod::HEAD:
+                    $registry = $this->_headRequestRegistry;
+                    break;
+
+                case RequestMethod::PATCH:
+                    $registry = $this->_patchRequestRegistry;
+                    break;
             }
 
             if ($registry === null) {