Configure error pages in routes.php

Author: smichaelsen

CHANGELOG.md

@@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file.
 * Repositories now have a `->remove()` method to delete model objects.
 * `ViewFactory` to instanciate a view object whenever needed
 * Signal in the `ViewFactory` to make implementations of other templating engines possible.
+* Configure error pages for HTTP status codes in your `routes.php`.
 
 ### Changed
 

classes/Http/HttpErrorException.php

@@ -0,0 +1,4 @@
+<?php
+namespace AppZap\PHPFramework\Http;
+
+class HttpErrorException extends \Exception {}

classes/Mail/TransportFactory.php

@@ -65,4 +65,4 @@ protected function createSmtpTransport() {
     return $transport;
   }
 
-}
+}

classes/Mvc/Dispatcher.php

@@ -2,6 +2,7 @@
 namespace AppZap\PHPFramework\Mvc;
 
 use AppZap\PHPFramework\Cache\CacheFactory;
+use AppZap\PHPFramework\Http\HttpErrorException;
 use AppZap\PHPFramework\Mvc\View\ViewFactory;
 use AppZap\PHPFramework\SignalSlot\Dispatcher as SignalSlotDispatcher;
 
@@ -42,8 +43,8 @@ class Dispatcher {
   public function __construct() {
     SignalSlotDispatcher::emitSignal(self::SIGNAL_CONSTRUCT);
     $this->cache = CacheFactory::getCache();
-    $this->determineRequestMethod();
     $this->viewFactory = ViewFactory::getInstance();
+    $this->determineRequestMethod();
   }
 
   /**
@@ -103,15 +104,23 @@ protected function getRouter($uri) {
   }
 
   /**
-   * @param $uri
+   * @param string $uri
    * @return string
+   * @throws \Exception
    */
   protected function dispatchUncached($uri) {
-    $router = $this->getRouter($uri);
-    if (is_callable($router->getResponder())) {
-      $output = $this->dispatchCallable($router);
-    } else {
-      $output = $this->dispatchController($router);
+    try {
+      $router = $this->getRouter($uri);
+      if (is_callable($router->getResponder())) {
+        $output = $this->dispatchCallable($router);
+      } else {
+        $output = $this->dispatchController($router);
+      }
+    } catch (HttpErrorException $e) {
+      if (!$e->getCode()) {
+        throw new \Exception('HttpErrorException was thrown without HTTP Status code', 1421830421);
+      }
+      return $this->dispatchUncached($e->getCode());
     }
     return $output;
   }

classes/Mvc/Router.php

@@ -2,6 +2,7 @@
 namespace AppZap\PHPFramework\Mvc;
 
 use AppZap\PHPFramework\Configuration\Configuration;
+use AppZap\PHPFramework\Http\HttpErrorException;
 use AppZap\PHPFramework\SignalSlot\Dispatcher as SignalSlotDispatcher;
 
 class Router {
@@ -20,21 +21,23 @@ class Router {
 
   /**
    * @param string $resource
-   * @throws ApplicationPartMissingException
+   * @throws HttpErrorException
    * @throws InvalidHttpResponderException
    */
   public function __construct($resource) {
     $routes = $this->collectRoutesDefinitions();
     $this->route($routes, $resource);
 
-    // check if the responder is valid
-    if (is_string($this->responder)) {
-      if (!class_exists($this->responder)) {
-        throw new InvalidHttpResponderException('Controller ' . $this->responder . ' for uri "' . $resource . '" not found!', 1415129223);
-      }
-    } elseif(!isset($this->responder)) {
-      throw new InvalidHttpResponderException('Route ' . $resource . ' could not be routed.', 1415136995);
-    } elseif (!is_callable($this->responder)) {
+    if (!isset($this->responder)) {
+      HttpStatus::setStatus(HttpStatus::STATUS_404_NOT_FOUND);
+      throw new HttpErrorException('Resource not routable', 404);
+    }
+
+    if (is_string($this->responder) && !class_exists($this->responder)) {
+      throw new InvalidHttpResponderException('Controller ' . $this->responder . ' for uri "' . $resource . '" not found!', 1415129223);
+    }
+
+    if (!is_string($this->responder) && !is_callable($this->responder)) {
       throw new InvalidHttpResponderException('The responder must either be a class string, a callable or an array of subpaths', 1415129333);
     }
   }
@@ -54,34 +57,58 @@ protected function collectRoutesDefinitions() {
       if (!is_array($applicationRoutes)) {
         throw new InvalidHttpResponderException('The routes file did not return an array with routes', 1415135585);
       }
-      $routes = array_merge($routes, $applicationRoutes);
+      $routes = $applicationRoutes + $routes;
     }
     return $routes;
   }
 
   /**
    * @param array $routes
-   * @param string $resource
+   * @param mixed $resource
    */
   protected function route($routes, $resource) {
+    if (is_int($resource)) {
+      $this->routeHttpStatusCode($routes, $resource);
+      return;
+    }
     $resource = ltrim($resource, '/');
-    foreach ($routes as $regex => $regexResponder) {
+    foreach ($routes as $regex => $responder) {
+      if ($responder === FALSE) {
+        continue;
+      }
       $regex = $this->enhanceRegex($regex);
-      if ($regexResponder !== FALSE && preg_match($regex, $resource, $matches)) {
+      if (preg_match($regex, $resource, $matches)) {
         $matchesCount = count($matches);
         for ($i = 1; $i < $matchesCount; $i++) {
           $this->parameters[] = $matches[$i];
         }
-        if (is_array($regexResponder)) {
-          $this->route($regexResponder, preg_replace($regex, '', $resource));
+        if (is_array($responder)) {
+          $this->route($responder, preg_replace($regex, '', $resource));
         } else {
-          $this->responder = $regexResponder;
+          $this->responder = $responder;
         }
         break;
       }
     }
   }
 
+  /**
+   * @param array $routes
+   * @param int $httpStatusCode
+   */
+  protected function routeHttpStatusCode($routes, $httpStatusCode) {
+    if (isset($routes[$httpStatusCode])) {
+      $this->responder = $routes[$httpStatusCode];
+      return;
+    }
+    // convert e.g. 405 to 400
+    $baseStatusCode = (int) floor($httpStatusCode / 100) * 100;
+    if (isset($routes[$baseStatusCode])) {
+      $this->responder = $routes[$baseStatusCode];
+      return;
+    }
+  }
+
   /**
    * @return array
    */

classes/Mvc/View/ViewInterface.php

@@ -38,4 +38,4 @@ public function setTemplatesDirectory($templatesDirectory);
    */
   public function render($templateName = NULL);
 
-}
+}

tests/Unit/Mvc/RouterTest.php

@@ -73,8 +73,8 @@ public function neitherClassNorCallableButInteger() {
 
   /**
    * @test
-   * @expectedException \AppZap\PHPFramework\Mvc\InvalidHttpResponderException
-   * @expectedExceptionCode 1415136995
+   * @expectedException \AppZap\PHPFramework\Http\HttpErrorException
+   * @expectedExceptionCode 404
    */
   public function resourceNotRoutable() {
     $this->loadRoutesFile('classnames');
@@ -87,13 +87,14 @@ public function resourceNotRoutable() {
   public function routeToClassNames() {
     $this->loadRoutesFile('classnames');
     $router = new Router('/');
-    $responder_class = $router->getResponder();
-    $this->assertTrue(class_exists($responder_class));
-    $this->assertSame('\AppZap\PHPFramework\Tests\Mvc\Responder_Index', $responder_class);
+    $responderClass = $router->getResponder();
+    $this->assertTrue(is_string($responderClass), '$responderClass (' . gettype($responderClass) . ') should be string');
+    $this->assertTrue(class_exists($responderClass));
+    $this->assertSame('\AppZap\PHPFramework\Tests\Mvc\Responder_Index', $responderClass);
     $router = new Router('/foo');
-    $responder_class = $router->getResponder();
-    $this->assertTrue(class_exists($responder_class));
-    $this->assertSame('\AppZap\PHPFramework\Tests\Mvc\Responder_Foo', $responder_class);
+    $responderClass = $router->getResponder();
+    $this->assertTrue(class_exists($responderClass));
+    $this->assertSame('\AppZap\PHPFramework\Tests\Mvc\Responder_Foo', $responderClass);
   }
 
   /**