Merge pull request #17 from SebKay/error-handling

Error handling

Author: SebKay

resources/views/layouts/http-error.twig

@@ -1,11 +1,19 @@
 {% extends 'base.twig' %}
 
 {% block body %}
-    <h2>
-        {{ code }} - {{ description }}
-    </h2>
+    <div class="txt-center">
+        <h2>
+            {{ code }}
+            {% if description %}
+                -
+                {{ description }}
+            {% endif %}
+        </h2>
 
-    <p>
-        Please get in touch if this problem persists.
-    </p>
+        <br>
+
+        <p>
+            Please get in touch if this problem persists.
+        </p>
+    </div>
 {% endblock %}

src/App.php

@@ -9,6 +9,8 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Slim\App as SlimApp;
 use DI\Bridge\Slim\Bridge as AppFactory;
+use Slim\Handlers\ErrorHandler as SlimErrorHandler;
+use Slim\Middleware\ErrorMiddleware;
 
 class App
 {
@@ -27,6 +29,11 @@ class App
      */
     protected $slim;
 
+    /**
+     * @var ErrorMiddleware
+     */
+    protected $error_middleware;
+
     /**
      * @var Logger
      */
@@ -95,14 +102,29 @@ protected function addMiddleware(): void
 
         $this->slim()->add($this->container()->get('csrf'));
 
-        $this->slim()->addErrorMiddleware(
+        $this->error_middleware = $this->slim()->addErrorMiddleware(
             $this->isDevelopmentMode(),
             true,
             true,
             $this->logger
         );
     }
 
+    /**
+     * Add error rendering
+     */
+    protected function addErrorRenderers(): void
+    {
+        $error_handler = $this->error_middleware->getDefaultErrorHandler();
+
+        if ($error_handler instanceof SlimErrorHandler) {
+            $error_handler->registerErrorRenderer(
+                'text/html',
+                $this->container()->get('error-renderer-html')
+            );
+        }
+    }
+
     /**
      * Define routes
      */
@@ -117,6 +139,7 @@ protected function addRoutes(): void
     protected function setupSlim(): void
     {
         $this->addMiddleware();
+        $this->addErrorRenderers();
         $this->addRoutes();
     }
 

src/Container/ContainerCreator.php

@@ -27,6 +27,7 @@ protected function services(): array
     {
         return [
             LoggerService::class,
+            ErrorRendererHTMLService::class,
             CSRFService::class,
             ViewService::class
         ];

src/Container/ErrorRendererHTMLService.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Container;
+
+use App\ErrorRendererHTML;
+
+class ErrorRendererHTMLService extends Service
+{
+    public static function name(): string
+    {
+        return 'error-renderer-html';
+    }
+
+    public function config(): string
+    {
+        return ErrorRendererHTML::class;
+    }
+}

src/Controllers/Controller.php

@@ -23,11 +23,6 @@ abstract class Controller
      */
     protected $csrf;
 
-    /**
-     * Set up
-     *
-     * @param Container $container
-     */
     public function __construct(Container $container)
     {
         $this->container = $container;

src/ErrorRendererHTML.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App;
+
+use App\Dependencies\View;
+use DI\Container;
+use Slim\Interfaces\ErrorRendererInterface;
+
+class ErrorRendererHTML implements ErrorRendererInterface
+{
+    /**
+     * @var Container
+     */
+    protected $container;
+
+    /**
+     * @var View
+     */
+    protected $view;
+
+    public function __construct(Container $container)
+    {
+        $this->container = $container;
+        $this->view      = $this->container->get('view');
+    }
+
+    public function __invoke(\Throwable $exception, bool $displayErrorDetails): string
+    {
+        return $this->view->render('layouts/http-error.twig', [
+            'code'        => $exception->getCode(),
+            'description' => Helpers::getHttpStatusMessage($exception->getCode()),
+        ]);
+    }
+}

src/Helpers.php

@@ -28,4 +28,75 @@ public static function generateCSRFData(Guard $csrf_guard, ServerRequestInterfac
             'value' => $request->getAttribute($value_key)
         ];
     }
+
+    public static function httpStatuses(): array
+    {
+        return [
+            100 => 'Continue',
+            101 => 'Switching Protocols',
+            102 => 'Processing',
+            103 => 'Checkpoint',
+            200 => 'OK',
+            201 => 'Created',
+            202 => 'Accepted',
+            203 => 'Non-Authoritative Information',
+            204 => 'No Content',
+            205 => 'Reset Content',
+            206 => 'Partial Content',
+            207 => 'Multi-Status',
+            300 => 'Multiple Choices',
+            301 => 'Moved Permanently',
+            302 => 'Found',
+            303 => 'See Other',
+            304 => 'Not Modified',
+            305 => 'Use Proxy',
+            306 => 'Switch Proxy',
+            307 => 'Temporary Redirect',
+            400 => 'Bad Request',
+            401 => 'Unauthorized',
+            402 => 'Payment Required',
+            403 => 'Forbidden',
+            404 => 'Not Found',
+            405 => 'Method Not Allowed',
+            406 => 'Not Acceptable',
+            407 => 'Proxy Authentication Required',
+            408 => 'Request Timeout',
+            409 => 'Conflict',
+            410 => 'Gone',
+            411 => 'Length Required',
+            412 => 'Precondition Failed',
+            413 => 'Request Entity Too Large',
+            414 => 'Request-URI Too Long',
+            415 => 'Unsupported Media Type',
+            416 => 'Requested Range Not Satisfiable',
+            417 => 'Expectation Failed',
+            418 => "I'm a teapot",
+            422 => 'Unprocessable Entity',
+            423 => 'Locked',
+            424 => 'Failed Dependency',
+            425 => 'Unordered Collection',
+            426 => 'Upgrade Required',
+            449 => 'Retry With',
+            450 => 'Blocked by Windows Parental Controls',
+            500 => 'Internal Server Error',
+            501 => 'Not Implemented',
+            502 => 'Bad Gateway',
+            503 => 'Service Unavailable',
+            504 => 'Gateway Timeout',
+            505 => 'HTTP Version Not Supported',
+            506 => 'Variant Also Negotiates',
+            507 => 'Insufficient Storage',
+            509 => 'Bandwidth Limit Exceeded',
+            510 => 'Not Extended'
+        ];
+    }
+
+    /**
+     * @param int|string $code
+     * @return string
+     */
+    public static function getHttpStatusMessage($code): string
+    {
+        return (string) (self::httpStatuses()[$code] ?? '');
+    }
 }