Merge pull request #74 from skipperbent/development

Custom boot-managers

README.md

@@ -1,18 +1,11 @@
 # Simple PHP router
-Simple, fast and yet powerful PHP router that is easy to get integrated and in any project. Heavily inspired by the way Laravel handles routing.
+Simple, fast and yet powerful PHP router that is easy to get integrated and in any project. Heavily inspired by the way Laravel handles routing, with both simplicity and expandability in mind.
 
 ## Installation
-Add the latest version of Simple PHP Router to your ```composer.json```
+Add the latest version of Simple PHP Router running this command.
 
-```json
-{
-    "require": {
-        "pecee/simple-php-router": "1.*"
-    },
-    "require-dev": {
-        "pecee/simple-php-router": "1.*"
-    }
-}
+```
+composer require pecee/framework
 ```
 
 ## Notes
@@ -32,10 +25,7 @@ The goal of this project is to create a router that is 100% compatible with the
 - CSRF protection.
 - Optional parameters
 - Sub-domain routing
-
-### Features currently "in-the-works"
-
-- Global Constraints
+- Custom boot managers to redirect urls to other routes
 
 ## Initialising the router
 
@@ -77,7 +67,7 @@ SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\So
     SimpleRouter::group(['prefix' => '/services', 'exceptionHandler' => '\MyProject\Handler\CustomExceptionHandler'], function() {
 
         SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show')->where(['id' => '[0-9]+');
-        
+
         // Optional parameter
         SimpleRouter::get('/answers/{id?}', 'ControllerAnswers@show');
 
@@ -175,10 +165,10 @@ class Router extends SimpleRouter {
             $exceptionHandler = null;
 
             // Load and use exception-handler defined on group
-            
+
             if($route && $route->getGroup()) {
                 $exceptionHandler = $route->getGroup()->getExceptionHandler();
-                
+
                 if($exceptionHandler !== null) {
                     $class = new $exceptionHandler();
                     $class->handleError(RouterBase::getInstance()->getRequest(), $route, $e);
@@ -186,7 +176,7 @@ class Router extends SimpleRouter {
             }
 
             // Otherwise use the fallback default exceptions handler
-           
+
             if(self::$defaultExceptionHandler !== null) {
                 $class = new self::$defaultExceptionHandler();
                 $class->handleError(RouterBase::getInstance()->getRequest(), $route, $e);
@@ -270,9 +260,63 @@ Register the new class in your ```routes.php```, custom ```Router``` class or wh
 SimpleRouter::csrfVerifier(new \Demo\Middleware\CsrfVerifier());
 ```
 
+## Using router bootmanager to make custom rewrite rules
+
+Sometimes it can be necessary to keep urls stored in the database, file or similar. In this example, we want the url ```/my-cat-is-beatiful``` to load the route ```/article/view/1``` which the router knows, because it's defined in the ```routes.php``` file.
+
+To interfere with the router, we create a class that inherits from ```RouterBootManager```. This class will be loaded before any other rules in ```routes.php``` and allow us to "change" the current route, if any of our criteria are fulfilled (like comming from the url ```/my-cat-is-beatiful```).
+
+```php
+
+use Pecee\Http\Request;
+use Pecee\SimpleRouter\RouterBootManager;
+
+class CustomRouterRules extends RouterBootManager{
+
+    public function boot(Request $request) {
+
+        $rewriteRules = [
+            '/my-cat-is-beatiful' => '/article/view/1',
+            '/horses-are-great' => '/article/view/2'
+        ];
+
+        foreach($rewriteRules as $url => $rule) {
+
+            // If the current uri matches the url, we use our custom route
+
+            if($request->getUri() === $url) {
+                $request->setUri($rule);
+            }
+        }
+
+        return $request;
+    }
+
+}
+
+```
+
+The above should be pretty self-explanatory and can easily be changed to loop through urls store in the database, file or cache.
+
+What happens is that if the current route matches the route defined in the index of our ```$rewriteRules``` array, we set the route to the array value instead.
+
+By doing this the route will now load the url ```/article/view/1``` instead of ```/my-cat-is-beatiful```.
+
+The last thing we need to do, is to add our custom boot-manager to the ```routes.php``` file. You can create as many bootmanagers as you like and easily add them in your ```routes.php``` file.
+
+**routes.php example:**
+
+```php
+// Add new bootmanager
+SimpleRouter::addBootManager(new CustomRouterRules());
+
+// This rule is what our custom bootmanager will use.
+SimpleRouter::get('/article/view/{id}', 'ControllerArticle@view');
+```
+
 ## Easily overwrite route about to be loaded
-Sometimes it can be useful to manipulate the route that's about to be loaded, for instance if a user is not authenticated or if an error occurred within your Middleware that requires 
-some other route to be initialised. Simple PHP Router allows you to easily change the route about to be executed. All information about the current route is stored in 
+Sometimes it can be useful to manipulate the route that's about to be loaded, for instance if a user is not authenticated or if an error occurred within your Middleware that requires
+some other route to be initialised. Simple PHP Router allows you to easily change the route about to be executed. All information about the current route is stored in
 the ```\Pecee\SimpleRouter\Http\Request``` object.
 
 **Note:** Please note that it's only possible to change the route BEFORE any route has initially been loaded, so doing this in your custom ExceptionHandler or Middleware is highly recommended.
@@ -297,11 +341,11 @@ http://laravel.com/docs/5.1/routing
 The router can be easily extended to customize your needs.
 
 ## Ideas and issues
-If you want a great new feature or experience any issues what-so-ever, please feel free to leave an issue and i'll look into it whenever possible. 
+If you want a great new feature or experience any issues what-so-ever, please feel free to leave an issue and i'll look into it whenever possible.
 
 ## The MIT License (MIT)
 
-Copyright (c) 2015 Simon Sessingø / simple-php-router
+Copyright (c) 2016 Simon Sessingø / simple-php-router
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

src/Pecee/Exception/RouterException.php

@@ -1,3 +1,3 @@
 <?php
-namespace Pecee\SimpleRouter;
+namespace Pecee\Exception;
 class RouterException extends \Exception { }

src/Pecee/Http/Request.php

@@ -1,18 +1,11 @@
 <?php
 namespace Pecee\Http;
 
-use Pecee\SimpleRouter\RouterBase;
-
 class Request {
 
     protected static $instance;
 
     protected $data;
-    protected $uri;
-    protected $host;
-    protected $method;
-    protected $headers;
-    protected $loadedRoute;
 
     /**
      * Return new instance
@@ -138,6 +131,17 @@ class Request {
         return (isset($_REQUEST[$name]) ? $_REQUEST[$name] : $defaultValue);
     }
 
+    public function isFormatAccepted($format) {
+        return (isset($_SERVER['HTTP_ACCEPT']) && stripos($_SERVER['HTTP_ACCEPT'], $format) > -1);
+    }
+
+    public function getAcceptFormats() {
+        if(isset($_SERVER['HTTP_ACCEPT'])) {
+            return explode(',', $_SERVER['HTTP_ACCEPT']);
+        }
+        return array();
+    }
+
     public function __set($name, $value = null) {
         $this->data[$name] = $value;
     }
@@ -154,4 +158,25 @@ class Request {
         return $this->loadedRoute;
     }
 
+    /**
+     * @param mixed $uri
+     */
+    public function setUri($uri) {
+        $this->uri = $uri;
+    }
+
+    /**
+     * @param mixed $host
+     */
+    public function setHost($host) {
+        $this->host = $host;
+    }
+
+    /**
+     * @param mixed $method
+     */
+    public function setMethod($method) {
+        $this->method = $method;
+    }
+
 }

src/Pecee/Http/Response.php

@@ -26,7 +26,7 @@ class Response {
             $this->httpCode($httpCode);
         }
 
-        $this->header('Location: ' . $url);
+        $this->header('location: ' . $url);
         die();
     }
 

src/Pecee/SimpleRouter/IRouteEntry.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace Pecee\SimpleRouter;
-
-interface IRouteEntry {
-
-}

src/Pecee/SimpleRouter/RouterBase.php

@@ -2,6 +2,7 @@
 namespace Pecee\SimpleRouter;
 
 use Pecee\CsrfToken;
+use Pecee\Exception\RouterException;
 use Pecee\Http\Middleware\BaseCsrfVerifier;
 use Pecee\Http\Request;
 
@@ -16,9 +17,9 @@ class RouterBase {
     protected $controllerUrlMap;
     protected $backStack;
     protected $defaultNamespace;
+    protected $bootManagers;
     protected $baseCsrfVerifier;
 
-    // TODO: make interface for controller routers, so they can be easily detected
     // TODO: clean up - cut some of the methods down to smaller pieces
 
     public function __construct() {
@@ -26,7 +27,8 @@ class RouterBase {
         $this->backStack = array();
         $this->controllerUrlMap = array();
         $this->baseCsrfVerifier = new BaseCsrfVerifier();
-        $this->request = Request::getInstance();
+        $this->request = new Request();
+        $this->bootManagers = array();
 
         $csrf = new CsrfToken();
         $token = ($csrf->hasToken()) ? $csrf->getToken() : $csrf->generateToken();
@@ -86,7 +88,7 @@ class RouterBase {
 
             $this->currentRoute = $route;
 
-            if($route instanceof RouterGroup && is_callable($route->getCallback())) {
+            if($route instanceof RouterGroup && $route->matchRoute($this->request) && is_callable($route->getCallback())) {
                 $group = $route;
                 $route->renderRoute($this->request);
                 $mergedSettings = array_merge($route->getMergeableSettings(), $settings);
@@ -106,6 +108,18 @@ class RouterBase {
 
     public function routeRequest() {
 
+        // Initialize boot-managers
+        if(count($this->bootManagers)) {
+            /* @var $manager RouterBootManager */
+            foreach($this->bootManagers as $manager) {
+                $this->request = $manager->boot($this->request);
+
+                if(!($this->request instanceof Request)) {
+                    throw new RouterException('Custom router bootmanager "'. get_class($manager) .'" must return instance of Request.');
+                }
+            }
+        }
+
         // Verify csrf token for request
         if($this->baseCsrfVerifier !== null) {
             /* @var $csrfVerifier BaseCsrfVerifier */
@@ -126,12 +140,6 @@ class RouterBase {
 
             $route = $this->controllerUrlMap[$i];
 
-            if($route->getGroup() !== null) {
-                if($route->getGroup()->matchDomain($this->request) === false) {
-                    continue;
-                }
-            }
-
             $routeMatch = $route->matchRoute($this->request);
 
             if($routeMatch) {
@@ -174,6 +182,24 @@ class RouterBase {
         $this->defaultNamespace = $defaultNamespace;
     }
 
+    /**
+     * @return array
+     */
+    public function getBootManagers() {
+        return $this->bootManagers;
+    }
+
+    /**
+     * @param array $bootManagers
+     */
+    public function setBootManagers(array $bootManagers) {
+        $this->bootManagers = $bootManagers;
+    }
+
+    public function addBootManager(RouterBootManager $bootManager) {
+        $this->bootManagers[] = $bootManager;
+    }
+
     /**
      * @return RouterEntry
      */

src/Pecee/SimpleRouter/RouterBootManager.php

@@ -0,0 +1,10 @@
+<?php
+namespace Pecee\SimpleRouter;
+
+use Pecee\Http\Request;
+
+abstract class RouterBootManager {
+
+    abstract public function boot(Request $request);
+
+}

src/Pecee/SimpleRouter/RouterController.php

@@ -1,6 +1,7 @@
 <?php
 namespace Pecee\SimpleRouter;
 
+use Pecee\Exception\RouterException;
 use Pecee\Http\Request;
 
 class RouterController extends RouterEntry {

src/Pecee/SimpleRouter/RouterEntry.php

@@ -2,6 +2,7 @@
 
 namespace Pecee\SimpleRouter;
 
+use Pecee\Exception\RouterException;
 use Pecee\Http\Middleware\IMiddleware;
 use Pecee\Http\Request;
 
@@ -201,7 +202,7 @@ abstract class RouterEntry {
      */
     public function addSettings(array $settings = null) {
         if(is_array($settings)) {
-            $this->settings = array_merge($this->settings, $settings);
+            $this->settings = array_merge($settings, $this->settings);
         }
         return $this;
     }

src/Pecee/SimpleRouter/RouterGroup.php

@@ -2,6 +2,7 @@
 
 namespace Pecee\SimpleRouter;
 
+use Pecee\Exception\RouterException;
 use Pecee\Http\Request;
 
 class RouterGroup extends RouterEntry {
@@ -66,7 +67,12 @@ class RouterGroup extends RouterEntry {
     }
 
     public function matchRoute(Request $request) {
-        return null;
+        // Skip if prefix doesn't match
+        if($this->getPrefix() !== null && stripos($request->getUri(), $this->getPrefix()) === false) {
+            return false;
+        }
+
+        return $this->matchDomain($request);
     }
 
     public function setExceptionHandler($class) {

src/Pecee/SimpleRouter/RouterResource.php

@@ -1,6 +1,7 @@
 <?php
 namespace Pecee\SimpleRouter;
 
+use Pecee\Exception\RouterException;
 use Pecee\Http\Request;
 
 class RouterResource extends RouterEntry {

src/Pecee/SimpleRouter/SimpleRouter.php

@@ -32,6 +32,10 @@ class SimpleRouter {
         RouterBase::getInstance()->setBaseCsrfVerifier($baseCsrfVerifier);
     }
 
+    public static function addBootManager(RouterBootManager $bootManager) {
+        RouterBase::getInstance()->addBootManager($bootManager);
+    }
+
     public static function get($url, $callback, array $settings = null) {
         $route = new RouterRoute($url, $callback);
         $route->addSettings($settings);