added multiple 404 routes

Author: uvulpos

README.md

@@ -289,6 +289,21 @@ $router->set404(function() {
 });
 ```
 
+You can also define multiple custom routes e.x. you want to define an `/api` route, you can print a custom 404 page:
+
+```php
+$router->set404('/api(/.*)?', function() {
+    header('HTTP/1.1 404 Not Found');
+    header('Content-Type: application/json');
+
+    $jsonArray = array();
+    $jsonArray['status'] = "404";
+    $jsonArray['status_text'] = "route not defined";
+
+    echo json_encode($jsonArray);
+});
+```
+
 Also supported are `Class@Method` callables:
 
 ```php

demo/index.php

@@ -19,14 +19,49 @@
         echo '404, route not found!';
     });
 
+    // custom 404
+    $router->set404('/test(/.*)?', function () {
+        header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
+        echo '<h1><mark>404, route not found!</mark></h1>';
+    });
+
+    $router->set404('/api(/.*)?', function() {
+        header('HTTP/1.1 404 Not Found');
+        header('Content-Type: application/json');
+
+        $jsonArray = array();
+        $jsonArray['status'] = "404";
+        $jsonArray['status_text'] = "route not defined";
+
+        echo json_encode($jsonArray);
+    });
+
     // Before Router Middleware
     $router->before('GET', '/.*', function () {
         header('X-Powered-By: bramus/router');
     });
 
     // Static route: / (homepage)
     $router->get('/', function () {
-        echo '<h1>bramus/router</h1><p>Try these routes:<p><ul><li>/hello/<em>name</em></li><li>/blog</li><li>/blog/<em>year</em></li><li>/blog/<em>year</em>/<em>month</em></li><li>/blog/<em>year</em>/<em>month</em>/<em>day</em></li><li>/movies</li><li>/movies/<em>id</em></li></ul>';
+        echo '<h1>bramus/router</h1>
+              <p>Try these routes:<p>
+              <ul>
+                <li><a href="/hello/joe">/hello/<em>name</em></a></li>
+                <li><a href="/blog">/blog</a></li>
+                <li><a href="/blog/'.date('Y').'">/blog/<em>year</em></a></li>
+                <li><a href="/blog/'.date('Y').'/'.date('m').'">/blog/<em>year</em>/<em>month</em></a></li>
+                <li><a href="/blog/'.date('Y').'/'.date('m').'/'.date('d').'">/blog/<em>year</em>/<em>month</em>/<em>day</em></a></li>
+                <li><a href="/movies">/movies</a></li>
+                <li><a href="/movies/23">/movies/<em>id</em></a></li>
+              </ul>
+              <br><br>
+              <p>Custom error routes</p>
+              <ul>
+                <li><a href="/something">/*</a> <em>Normal 404</em></li>
+                <li><a href="/test">/test/*</a> <em>Custom 404</em></li>
+                <li><a href="/api/getUser">/api/getUser</a> <em>API 404</em></li>
+              </ul>
+        ';
     });
 
     // Static route: /hello

src/Bramus/Router/Router.php

@@ -23,9 +23,9 @@ class Router
     private $beforeRoutes = array();
 
     /**
-     * @var object|callable The function to be executed when no route has been matched
+     * @var array [object|callable] The function to be executed when no route has been matched
      */
-    protected $notFoundCallback;
+    protected $notFoundCallback = [];
 
     /**
      * @var string Current base route, used for (sub)route mounting
@@ -289,7 +289,7 @@ public function run($callback = null)
 
         // If no route was handled, trigger the 404 (if any)
         if ($numHandled === 0) {
-            $this->trigger404();
+            $this->trigger404($this->afterRoutes[$this->requestedMethod]);
         } // If a route was handled, perform the finish callback (if any)
         else {
             if ($callback && is_callable($callback)) {
@@ -309,24 +309,92 @@ public function run($callback = null)
     /**
      * Set the 404 handling function.
      *
+     * @param object|callable|string $match_fn The function to be executed
      * @param object|callable $fn The function to be executed
      */
-    public function set404($fn)
+    public function set404($match_fn, $fn = null)
     {
-        $this->notFoundCallback = $fn;
+      if (!is_null($fn)) {
+        $this->notFoundCallback[$match_fn] = $fn;
+      } else {
+        $this->notFoundCallback['/'] = $match_fn;
+      }
     }
 
     /**
      * Triggers 404 response
+     *
+     * @param string $pattern A route pattern such as /about/system
      */
-    public function trigger404(){
-        if ($this->notFoundCallback) {
-            $this->invoke($this->notFoundCallback);
-        } else {
-            header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
+    public function trigger404($match = null){
+
+        // Counter to keep track of the number of routes we've handled
+        $numHandled = 0;
+
+        // handle 404 pattern
+        if (count($this->notFoundCallback) > 0)
+        {
+            // loop fallback-routes
+            foreach ($this->notFoundCallback as $route_pattern => $route_callable) {
+
+              // matches result
+              $matches = [];
+
+              // check if there is a match and get matches as $matches (pointer)
+              $is_match = $this->patternMatches($route_pattern, $this->getCurrentUri(), $matches, PREG_OFFSET_CAPTURE);
+
+              // is fallback route match?
+              if ($is_match) {
+
+                // Rework matches to only contain the matches, not the orig string
+                $matches = array_slice($matches, 1);
+
+                // Extract the matched URL parameters (and only the parameters)
+                $params = array_map(function ($match, $index) use ($matches) {
+
+                  // We have a following parameter: take the substring from the current param position until the next one's position (thank you PREG_OFFSET_CAPTURE)
+                  if (isset($matches[$index + 1]) && isset($matches[$index + 1][0]) && is_array($matches[$index + 1][0])) {
+                    if ($matches[$index + 1][0][1] > -1) {
+                      return trim(substr($match[0][0], 0, $matches[$index + 1][0][1] - $match[0][1]), '/');
+                    }
+                  } // We have no following parameters: return the whole lot
+
+                  return isset($match[0][0]) && $match[0][1] != -1 ? trim($match[0][0], '/') : null;
+                }, $matches, array_keys($matches));
+
+                $this->invoke($route_callable);
+
+                ++$numHandled;
+              }
+            }
+            if($numHandled == 0 and $this->notFoundCallback['/']) {
+              $this->invoke($this->notFoundCallback['/']);
+            } elseif ($numHandled == 0) {
+              header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
+            }
         }
     }
 
+    /**
+    * Replace all curly braces matches {} into word patterns (like Laravel)
+    * Checks if there is a routing match
+    *
+    * @param $pattern
+    * @param $uri
+    * @param $matches
+    * @param $flags
+    *
+    * @return bool -> is match yes/no
+    */
+    private function patternMatches($pattern, $uri, &$matches, $flags)
+    {
+      // Replace all curly braces matches {} into word patterns (like Laravel)
+      $pattern = preg_replace('/\/{(.*?)}/', '/(.*?)', $pattern);
+
+      // we may have a match!
+      return boolval(preg_match_all('#^' . $pattern . '$#', $uri, $matches, PREG_OFFSET_CAPTURE));
+    }
+
     /**
      * Handle a a set of routes: if a match is found, execute the relating handling function.
      *
@@ -345,11 +413,13 @@ private function handle($routes, $quitAfterRun = false)
 
         // Loop all routes
         foreach ($routes as $route) {
-            // Replace all curly braces matches {} into word patterns (like Laravel)
-            $route['pattern'] = preg_replace('/\/{(.*?)}/', '/(.*?)', $route['pattern']);
 
-            // we have a match!
-            if (preg_match_all('#^' . $route['pattern'] . '$#', $uri, $matches, PREG_OFFSET_CAPTURE)) {
+            // get routing matches
+            $is_match = $this->patternMatches($route['pattern'], $uri, $matches, PREG_OFFSET_CAPTURE);
+
+            // is there a valid match?
+            if ($is_match) {
+
                 // Rework matches to only contain the matches, not the orig string
                 $matches = array_slice($matches, 1);
 

tests/RouterTest.php

@@ -628,6 +628,10 @@ public function test404()
                 echo 'route not found';
             });
 
+            $router->set404('/api(/.*)?', function () {
+                echo 'api route not found';
+            });
+
             // Test the /hello route
             ob_start();
             $_SERVER['REQUEST_URI'] = '/';
@@ -640,6 +644,12 @@ public function test404()
             $router->run();
             $this->assertEquals('route not found', ob_get_contents());
 
+            // Test the custom api 404
+            ob_clean();
+            $_SERVER['REQUEST_URI'] = '/api/getUser';
+            $router->run();
+            $this->assertEquals('api route not found', ob_get_contents());
+
             // Cleanup
             ob_end_clean();
         }