Feat: added config and updated related files

Author: jpneey

README.md

@@ -12,6 +12,19 @@ The `controller/controller.router.php` will render the current page(based on the
 Should something went wrong, please check if the included `.htaccess` file actually exists and `mod_rewrite` is available.<br> 
 The `.htaccess` should also be updated accordingly if you are not using `apache` and using other kind of webservers such as `nginx`.
 
+## Configuration
+It is advised to define the `BASE_URL` of your project from the `config.php` wether it is `http://example.com/` or
+`http://example.com/subfolder/`.
+
+The `BASE_ROUTE` constant is also required to be configured if your project's root directory is a subfolder.
+For example, a project to be deployed on `http://example.com/` can have the default `BASE_ROUTE` which is `0`.
+
+### Example:
+```
+`http://example.com/subfolder/` -> BASE_ROUTE = 1 
+`http://example.com/subfolder/another/` -> BASE_ROUTE = 2
+``` 
+
 ## Requirements
 Nothing special, just your server running on `PHP v5^` (apache prefered) and `mod_rewrite` enabled.
 

component/head.php

@@ -22,8 +22,8 @@
         <div class="col">
             <div class="d-block position-relative p-5 text-start shadow bg-white">
                 <p>Try the following links: </p>
-                <a href="http://localhost/basic-php-router/home/" class="btn btn-sm btn-primary px-4 py-2 mb-2 me-1">Home Page</a>
-                <a href="http://localhost/basic-php-router/about/" class="btn btn-sm btn-primary px-4 py-2 mb-2 me-1">About Page</a>
-                <a href="http://localhost/basic-php-router/a-404-page-or-somethin-random/" class="btn btn-sm btn-primary px-4 py-2 mb-2 me-1">A 404 Page</a>
+                <a href="<?= BASE_DIR ?>home/" class="btn btn-sm btn-primary px-4 py-2 mb-2 me-1">Home Page</a>
+                <a href="<?= BASE_DIR ?>about/" class="btn btn-sm btn-primary px-4 py-2 mb-2 me-1">About Page</a>
+                <a href="<?= BASE_DIR ?>a-404-page-or-somethin-random/" class="btn btn-sm btn-primary px-4 py-2 mb-2 me-1">A 404 Page</a>
             </div>
         </div>

config.php

@@ -0,0 +1,4 @@
+<?php
+
+define('BASE_DIR', 'https://php-router.herokuapp.com/');
+define('BASE_ROUTE', 0);

controller/controller.router.php

@@ -8,23 +8,21 @@ class Router {
      * Get the requested page
      *
      */
-    public function requestPage()
-    {
+    public function __construct(){
         $page = '404';
         if(isset($_SERVER["QUERY_STRING"])) {
             $uri = explode("/", $_SERVER["QUERY_STRING"]);
-            $page = isset($uri[0]) && !empty($uri[0]) ? $uri[0] : 'home';
+            $page = isset($uri[BASE_ROUTE]) && !empty($uri[BASE_ROUTE]) ? $uri[BASE_ROUTE] : 'home';
         }
         $this->request = $page;
-        return $this;
     }
 
     /**
      * Render the requested page
      * 
      */
 
-    public function renderPage()
+    public function init()
     {
         require_once 'include/include.import.php';
         switch(strtolower($this->request)) {

include/include.import.php

@@ -1,4 +1,4 @@
 <?php
 
-$BASE_DIR = 'http://localhost/php-router';
+$BASE_DIR = BASE_DIR;
 $variable = "Hello I'am a variable defined from <code>include/include.import.php</code>";

index.php

@@ -5,9 +5,9 @@
  * And render current view based on the URL request
  */
 
-require_once 'controller/controller.router.php';
+require 'config.php';
+require 'controller/controller.router.php';
 
 $router = new Router();
-$router->requestPage()->renderPage();
+$router->init();
 
-/* EOF */

page/404.php

@@ -4,7 +4,7 @@
 
 <div class="col">
     <div class="d-block position-relative p-5 text-start shadow bg-white">
-        <p>This is a <b>404</b> page! Routes not defined on <code>controller/controller.router.php</code> <code>renderPage()</code> will redirect here!</p>
+        <p>This is a <b>404</b> page! Routes not defined on <code>controller/controller.router.php</code> <code>init()</code> will redirect here!</p>
     </div>
 </div>
 <?php