Merge pull request #152 from Divyesh000/404

create a dynamic error controller

src/controllers/Cart.php

@@ -57,7 +57,7 @@ private function validateURL(): bool
     private function handleInvalidURL(): void
     {
         if (!$this->validateURL()) {
-            (new _404())->index();
+            (new Error())->handlePageNotFoundError();
             die();
         }
     }

src/controllers/Error.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steamy\Controller;
+
+use Steamy\Core\Controller;
+
+class Error
+{
+    use Controller;
+
+    private array $view_data;
+
+    public function __construct()
+    {
+        $this->view_data['error_message'] = '500 - Internal server error';
+        $this->view_data['extended_error_message'] = 'Something bad happened';
+    }
+
+    public function handleDatabaseError(): void
+    {
+        $this->view_data['extended_error_message'] = 'Unable to connect to database.';
+
+        $this->view(
+            'Error',
+            $this->view_data,
+            template_title: "Error",
+            enableIndexing: false
+        );
+    }
+
+    public function handlePageNotFoundError($extended_error_message = 'Ensure that you have properly typed the URL.'
+    ): void {
+        $this->view_data['error_message'] = '404 - Page not found';
+        $this->view_data['extended_error_message'] = $extended_error_message;
+
+        $this->view(
+            'Error',
+            $this->view_data,
+            template_title: "Page not found",
+            enableIndexing: false
+        );
+    }
+
+    public function handleUnknownError(): void
+    {
+        $this->view_data['extended_error_message'] = 'The server has encountered a situation 
+        it does not know how to handle.';
+
+        $this->view(
+            'Error',
+            $this->view_data,
+            template_title: "Unknown error",
+            enableIndexing: false
+        );
+    }
+
+    public function index(): void
+    {
+        $this->handlePageNotFoundError();
+    }
+}

src/controllers/Home.php

@@ -19,7 +19,7 @@ private function validateURL(): bool
     private function handleInvalidURL(): void
     {
         if (!$this->validateURL()) {
-            (new _404())->index();
+            (new Error())->handlePageNotFoundError();
             die();
         }
     }

src/controllers/Login.php

@@ -81,7 +81,7 @@ private function validateURL(): bool
     private function handleInvalidURL(): void
     {
         if (!$this->validateURL()) {
-            (new _404())->index();
+            (new Error())->handlePageNotFoundError();
             die();
         }
     }

src/controllers/Password.php

@@ -189,7 +189,7 @@ public function index(): void
         }
 
         // if url follows some other format display error page
-        (new _404())->index();
+        (new Error())->handlePageNotFoundError();
     }
 }
 

src/controllers/Product.php

@@ -243,7 +243,7 @@ private function validateURL(): bool
     private function handleInvalidURL(): void
     {
         if (!$this->validateURL()) {
-            (new _404())->index();
+            (new Error())->handlePageNotFoundError('Product does not exist');
             die();
         }
     }
@@ -254,7 +254,7 @@ public function index(): void
 
         // if product was not found, display error page
         if (empty($this->product)) {
-            (new _404())->index();
+            (new Error())->handlePageNotFoundError('Product does not exist.');
             return;
         }
 

src/controllers/Profile.php

@@ -150,7 +150,7 @@ private function validateURL(): bool
     private function handleInvalidURL(): void
     {
         if (!$this->validateURL()) {
-            (new _404())->index();
+            (new Error())->handlePageNotFoundError();
             die();
         }
     }

src/controllers/Register.php

@@ -115,8 +115,8 @@ private function handleFormSubmission(): void
                 Utility::redirect('login');
             }
 
-            // TODO: redirect to some error page
-            Utility::redirect('home');
+            (new Error())->index("An error occurred while processing your registration. Please try again later.");
+            die();
         } else {
             $this->loadDataToForm($form_data);
         }
@@ -148,7 +148,7 @@ private function validateURL(): bool
     private function handleInvalidURL(): void
     {
         if (!$this->validateURL()) {
-            (new _404())->index();
+            (new Error())->index("Page not found");
             die();
         }
     }

src/controllers/Shop.php

@@ -111,7 +111,7 @@ public function index(): void
         // check if URL is not /shop
         if (Utility::getURL() !== "shop") {
             // let 404 controller handle this
-            (new _404())->index();
+            (new Error())->handlePageNotFoundError();
             return;
         }
 

src/core/App.php

@@ -4,17 +4,33 @@
 
 namespace Steamy\Core;
 
-use Steamy\Controller\_404;
+use Steamy\Controller\Error;
 use Steamy\Controller\API;
+use Throwable;
 
 class App
 {
+
+    /**
+     * Global exception handler
+     * @param Throwable $exception
+     * @return void
+     */
+    public function exception_handler(Throwable $exception): void
+    {
+//        echo "Uncaught exception: ", $exception->getMessage(), "\n";
+        (new Error())->handleUnknownError();
+    }
+
+
     /**
      * Calls appropriate controller class to deal with URL.
      * @return void
      */
     public function loadController(): void
     {
+        set_exception_handler(array($this, "exception_handler"));
+
         $URL = Utility::splitURL();
 
         switch ($URL[0]) {
@@ -28,8 +44,8 @@ public function loadController(): void
                     // call appropriate controller
                     (new $controllerClassName())->index();
                 } else {
-                    // Fallback to 404 controller
-                    (new _404())->index();
+                    // Display error page
+                    (new Error())->handlePageNotFoundError();
                 }
         }
     }

src/core/Controller.php

@@ -86,7 +86,7 @@ public function view(
         if (file_exists($view_file_path)) {
             include $view_file_path;
         } else {
-            include __DIR__ . '/../views/404.php';
+            include __DIR__ . '/../views/Error.php';
         }
         $template_content = ob_get_contents();
         ob_end_clean();

src/core/Database.php

@@ -7,6 +7,7 @@
 use PDO;
 use PDOException;
 use stdClass;
+use Steamy\Controller\Error;
 
 trait Database
 {
@@ -25,8 +26,7 @@ protected static function connect(): PDO
         } catch (PDOException $e) {
             // if PHPUnit is not running, handle the exception
             if (!defined('PHPUNIT_STEAMY_TESTSUITE')) {
-                // TODO: Display a user-friendly error message
-                Utility::show("Sorry, we're unable to process your request at the moment. Please try again later.");
+                (new Error())->handleDatabaseError();
                 die();
             } else {
                 // if PHPUnit is running, re-throw the exception to allow it to propagate