Merge pull request #97 from skipperbent/development

- Added custom ExceptionHandler example to documentation.

README.md

@@ -30,6 +30,7 @@ The goal of this project is to create a router that is 100% compatible with the
 - Optional parameters
 - Sub-domain routing
 - Custom boot managers to redirect urls to other routes
+- Input manager; to manage `GET`, `POST` params.
 
 ## Initialising the router
 
@@ -102,6 +103,37 @@ SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\So
 });
 ```
 
+#### ExceptionHandler example
+
+This is a basic example of an ExceptionHandler implementation:
+
+```php
+namespace BB\Handlers;
+
+use Pecee\Http\Request;
+use Pecee\SimpleRouter\RouterEntry;
+
+class CustomExceptionHandler implements IExceptionHandler {
+
+    public function handleError( Request $request, RouterEntry $router = null, \Exception $error) {
+
+        // If the error-code is 404; show another route which contains the page-not-found
+        if($error->getCode() === 404) {
+            // Load your custom 404-page view
+        }
+
+        // Output error as json if on api path.
+        if(stripos($request->getUri(), '/api') !== false) {
+            response()->json(['error' => $error->getMessage()]);
+        }
+
+        // Otherwise default exception will be thrown by the router.
+
+    }
+
+}
+``
+
 ### Sub-domain routing
 
 Route groups may also be used to route wildcard sub-domains. Sub-domains may be assigned route parameters just like route URIs, allowing you to capture a portion of the sub-domain for usage in your route or controller. The sub-domain may be specified using the ```domain``` key on the group attribute array:
@@ -325,6 +357,75 @@ $route->setClass('Example\MyCustomClass');
 $route->setMethod('hello');
 ```
 
+## Using the Input class to manage parameters
+
+We've added the `Input` class to easy access parameters from your Controller-classes.
+
+**Return single parameter value (matches both GET, POST, FILE):**
+```php
+$value = Request::getInstance()->getInput()->get('name');
+```
+
+**Return parameter object (matches both GET, POST, FILE):**
+```php
+$object = Request::getInstance()->getInput()->getObject('name');
+```
+
+**Return specific GET parameter (where name is the name of your parameter):**
+```php
+$object = Request::getInstance()->getInput()->get->name;
+$object = Request::getInstance()->getInput()->post->name;
+$object = Request::getInstance()->getInput()->file->name;
+```
+
+**Return all parameters:**
+```php
+// Get all
+$objects = Request::getInstance()->getInput()->all();
+
+// Only match certain keys
+$objects = Request::getInstance()->getInput()->all([
+    'company_name',
+    'user_id'
+]);
+```
+
+All object inherits from `InputItem` class and will always contain these methods:
+- `getValue()` - returns the value of the input.
+- `getIndex()` - returns the index/key of the input.
+- `getName()` - returns a human friendly name for the input (company_name will be Company Name etc).
+
+`InputFile` has the same methods as above along with some other file-specific methods like:
+- `getTmpName()` - get file temporary name.
+- `getSize()` - get file size.
+- `move($destination)` - move file to destination.
+- `getContents()` - get file content.
+- `getType()` - get mime-type for file.
+- `getError()` - get file upload error.
+
+
+### Easy access your input
+Create a helper function to easily get access to the input elements.
+
+Example:
+
+```php
+/**
+ * Get input class
+ * @return \Pecee\Http\Input\Input
+ */
+function input() {
+    return \Pecee\Http\Request::getInstance()->getInput();
+}
+```
+
+Then you can easily do something like this in your controller:
+
+```php
+// Get parameter site_id or default-value 2
+$value = input()->get('site_id', '2');
+```
+
 ## Sites
 This is some sites that uses the simple-router project in production.
 

src/Pecee/Http/Input/Input.php

@@ -0,0 +1,197 @@
+<?php
+namespace Pecee\Http\Input;
+
+use Pecee\Http\Request;
+
+class Input {
+
+    /**
+     * @var \Pecee\Http\Input\InputCollection
+     */
+    public $get;
+
+    /**
+     * @var \Pecee\Http\Input\InputCollection
+     */
+    public $post;
+
+    /**
+     * @var \Pecee\Http\Input\InputCollection
+     */
+    public $file;
+
+    public function __construct() {
+        $this->setGet();
+        $this->setPost();
+        $this->setFile();
+    }
+
+    /**
+     * Get all get/post items
+     * @param array|null $filter Only take items in filter
+     * @return array
+     */
+    public function all(array $filter = null) {
+        $output = $this->get->getData();
+        $output = array_merge($output, $this->post->getData());
+
+        if($filter !== null) {
+            $tmp = array();
+            foreach($output as $key => $val) {
+                if(in_array($key, $filter)) {
+                    $tmp[$key] = $val;
+                }
+            }
+            return $tmp;
+        }
+
+        return $output;
+    }
+
+    public function getObject($index, $default = null) {
+        $index = (strpos($index, '[') > -1) ? substr($index, 0, strpos($index, '[')) : $index;
+
+        $element = $this->get->findFirst($index);
+
+        if($element !== null) {
+            return $element;
+        }
+
+        if(Request::getInstance()->getMethod() !== 'get') {
+
+            $element = $this->post->findFirst($index);
+
+            if ($element !== null) {
+                return $element;
+            }
+
+            $element = $this->file->findFirst($index);
+            if ($element !== null) {
+                return $element;
+            }
+        }
+
+        return $default;
+    }
+
+    /**
+     * Get input element value matching index
+     * @param string $index
+     * @param string|null $default
+     * @return string|null
+     */
+    public function get($index, $default = null) {
+
+        $key = (strpos($index, '[') > -1) ? substr($index, strpos($index, '[')+1, strpos($index, ']') - strlen($index)) : null;
+        $index = (strpos($index, '[') > -1) ? substr($index, 0, strpos($index, '[')) : $index;
+
+        $item = $this->getObject($index);
+
+        if($item !== null) {
+
+            if($item instanceof InputFile) {
+                return $item;
+            }
+
+            if (is_array($item->getValue())) {
+                return ($key !== null && isset($item->getValue()[$key])) ? $item->getValue()[$key] : $item->getValue();
+            }
+
+            return (trim($item->getValue()) === '') ? $default : $item->getValue();
+        }
+
+        return $default;
+    }
+
+    public function setGet() {
+        $this->get = new InputCollection();
+
+        if(count($_GET)) {
+            foreach($_GET as $key => $get) {
+                if(!is_array($get)) {
+                    $this->get->{$key} = new InputItem($key, $get);
+                    continue;
+                }
+
+                $output = array();
+
+                foreach($get as $k => $g) {
+                    $output[$k] = new InputItem($k, $g);
+                }
+
+                $this->get->{$key} = new InputItem($key, $output);
+            }
+        }
+    }
+
+    public function setPost() {
+        $this->post = new InputCollection();
+
+        $postVars = array();
+
+        if(in_array($_SERVER['REQUEST_METHOD'], ['PUT', 'PATCH', 'DELETE'])) {
+            parse_str(file_get_contents('php://input'), $postVars);
+        } else {
+            $postVars = $_POST;
+        }
+
+        if(count($postVars)) {
+
+            foreach($postVars as $key => $post) {
+                if(!is_array($post)) {
+                    $this->post->{strtolower($key)} = new InputItem($key, $post);
+                    continue;
+                }
+
+                $output = array();
+
+                foreach($post as $k=>$p) {
+                    $output[$k] = new InputItem($k, $p);
+                }
+
+                $this->post->{strtolower($key)} = new InputItem($key, $output);
+            }
+        }
+    }
+
+    public function setFile() {
+        $this->file = new InputCollection();
+
+        if(count($_FILES)) {
+            foreach($_FILES as $key => $value) {
+                // Multiple files
+                if(!is_array($value['name'])) {
+                    // Strip empty values
+                    if($value['error'] != '4') {
+                        $file = new InputFile($key);
+                        $file->setName($value['name']);
+                        $file->setSize($value['size']);
+                        $file->setType($value['type']);
+                        $file->setTmpName($value['tmp_name']);
+                        $file->setError($value['error']);
+                        $this->file->{strtolower($key)} = $file;
+                    }
+                    continue;
+                }
+
+                $output = array();
+
+                foreach($value['name'] as $k=>$val) {
+                    // Strip empty values
+                    if($value['error'][$k] != '4') {
+                        $file = new InputFile($k);
+                        $file->setName($value['name'][$k]);
+                        $file->setSize($value['size'][$k]);
+                        $file->setType($value['type'][$k]);
+                        $file->setTmpName($value['tmp_name'][$k]);
+                        $file->setError($value['error'][$k]);
+                        $output[$k] = $file;
+                    }
+                }
+
+                $this->file->{strtolower($key)} = new InputItem($key, $output);
+            }
+        }
+    }
+
+}

src/Pecee/Http/Input/InputCollection.php

@@ -0,0 +1,67 @@
+<?php
+namespace Pecee\Http\Input;
+
+class InputCollection implements \IteratorAggregate {
+
+    protected $data = array();
+
+    /**
+     * Search for input element matching index.
+     * Useful for searching for finding items where $index doesn't contain form name.
+     *
+     * @param string $index
+     * @return mixed
+     */
+    public function findFirst($index) {
+        if(count($this->data)) {
+
+            if(isset($this->data[$index])) {
+                return $this->data[$index];
+            }
+
+            foreach($this->data as $key => $value) {
+                if(strtolower($index) === strtolower($key)) {
+                    return $value;
+                }
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @param $index
+     * @throws \InvalidArgumentException
+     * @return InputItem
+     */
+    public function __get($index) {
+        $item = $this->findFirst($index);
+        // Ensure that item are always available
+        if($item === null) {
+            $this->data[$index] = new InputItem($index, null);
+            return $this->data[$index];
+        }
+
+        return $item;
+    }
+
+    public function __set($index, $value) {
+        $this->data[$index] = $value;
+    }
+
+    public function getData() {
+        return $this->data;
+    }
+
+    /**
+     * Retrieve an external iterator
+     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
+     * @return \Traversable An instance of an object implementing <b>Iterator</b> or
+     * <b>Traversable</b>
+     * @since 5.0.0
+     */
+    public function getIterator() {
+        return new \ArrayIterator($this->data);
+    }
+
+}

src/Pecee/Http/Input/InputFile.php

@@ -0,0 +1,68 @@
+<?php
+namespace Pecee\Http\Input;
+
+class InputFile extends InputItem {
+
+	protected $name;
+	protected $size;
+	protected $type;
+	protected $error;
+	protected $tmpName;
+
+	/**
+	 * @return string
+	 */
+	public function getSize() {
+		return $this->size;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getType() {
+		return $this->type;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getError() {
+		return $this->error;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getTmpName() {
+		return $this->tmpName;
+	}
+
+    public function getExtension() {
+		return pathinfo($this->getName(), PATHINFO_EXTENSION);
+    }
+
+	public function move($destination) {
+		return move_uploaded_file($this->tmpName, $destination);
+	}
+
+	public function getContents() {
+		return file_get_contents($this->tmpName);
+	}
+
+    public function setTmpName($name) {
+        $this->tmpName = $name;
+    }
+
+    public function setSize($size) {
+        $this->size = $size;
+    }
+
+    public function setType($type) {
+        $this->type = $type;
+    }
+
+    public function setError($error) {
+        $this->error = $error;
+    }
+
+}

src/Pecee/Http/Input/InputItem.php

@@ -0,0 +1,53 @@
+<?php
+namespace Pecee\Http\Input;
+
+class InputItem {
+
+    protected $index;
+    protected $name;
+    protected $value;
+
+    public function __construct($index, $value = null) {
+        $this->index = $index;
+        $this->value = $value;
+
+        // Make the name human friendly, by replace _ with space
+        $this->name = ucfirst(str_replace('_', ' ', $this->index));
+    }
+
+    /**
+     * @return array
+     */
+    public function getName() {
+        return $this->name;
+    }
+
+    /**
+     * @return array
+     */
+    public function getValue() {
+        return $this->value;
+    }
+
+    /**
+     * @return string
+     */
+    public function getIndex() {
+        return $this->index;
+    }
+
+    /**
+     * Set input name
+     * @param string $name
+     * @return static $this
+     */
+    public function setName($name) {
+        $this->name = $name;
+        return $this;
+    }
+
+    public function __toString() {
+        return (string)$this->getValue();
+    }
+
+}

src/Pecee/Http/Request.php

@@ -1,6 +1,8 @@
 <?php
 namespace Pecee\Http;
 
+use Pecee\Http\Input\Input;
+
 class Request {
 
     protected static $instance;
@@ -24,6 +26,7 @@ class Request {
         $this->uri = $_SERVER['REQUEST_URI'];
         $this->method = (isset($_POST['_method'])) ? strtolower($_POST['_method']) : strtolower($_SERVER['REQUEST_METHOD']);
         $this->headers = $this->getAllHeaders();
+        $this->input = new Input();
     }
 
     protected function getAllHeaders() {
@@ -93,7 +96,7 @@ class Request {
      * @return string
      */
     public function getIp() {
-        return isset($_SERVER['HTTP_X_FORWARDED_FOR']) ? $_SERVER['HTTP_X_FORWARDED_FOR'] : $_SERVER['REMOTE_ADDR'];
+        return ((isset($_SERVER['HTTP_X_FORWARDED_FOR']) && strlen($_SERVER['HTTP_X_FORWARDED_FOR'])) ? $_SERVER['HTTP_X_FORWARDED_FOR'] : $_SERVER['REMOTE_ADDR']);
     }
 
     /**
@@ -122,13 +125,11 @@ class Request {
     }
 
     /**
-     * Get request input or default value
-     * @param string $name
-     * @param string $defaultValue
-     * @return mixed
+     * Get input class
+     * @return Input
      */
-    public function getInput($name, $defaultValue) {
-        return (isset($_REQUEST[$name]) ? $_REQUEST[$name] : $defaultValue);
+    public function getInput() {
+        return $this->input;
     }
 
     public function isFormatAccepted($format) {

src/Pecee/SimpleRouter/RouterBase.php

@@ -19,15 +19,19 @@ class RouterBase {
     protected $defaultNamespace;
     protected $bootManagers;
     protected $baseCsrfVerifier;
+    protected $middlewaresToLoad;
+    protected $exceptionHandlers;
 
     // TODO: clean up - cut some of the methods down to smaller pieces
 
     public function __construct() {
+        $this->request = Request::getInstance();
         $this->routes = array();
         $this->backStack = array();
         $this->controllerUrlMap = array();
-        $this->request = Request::getInstance();
         $this->bootManagers = array();
+        $this->middlewaresToLoad = array();
+        $this->exceptionHandlers = array();
     }
 
     public function addRoute(RouterEntry $route) {
@@ -56,11 +60,9 @@ class RouterBase {
             }
 
             if($this->defaultNamespace && !$route->getNamespace()) {
-                $namespace = null;
+                $namespace = $this->defaultNamespace;
                 if ($route->getNamespace()) {
-                    $namespace = $this->defaultNamespace . '\\' . $route->getNamespace();
-                } else {
-                    $namespace = $this->defaultNamespace;
+                    $namespace .= '\\' . $route->getNamespace();
                 }
 
                 $route->setNamespace($namespace);
@@ -86,13 +88,16 @@ class RouterBase {
             if($route instanceof RouterGroup && is_callable($route->getCallback())) {
                 $group = $route;
 
-                // Load middleware on group if route matches
-                if($route->getPrefix() !== null && $route->matchRoute($this->request)) {
-                    $route->loadMiddleware($this->request);
-                }
-
                 $route->renderRoute($this->request);
                 $mergedSettings = array_merge($settings, $route->getMergeableSettings());
+
+                // Load middleware on group if route matches
+                if($route->getPrefix() !== null && $route->matchRoute($this->request)) {
+                    if($route->getExceptionHandler() !== null) {
+                        $this->exceptionHandlers[] = $route->getExceptionHandler();
+                    }
+                    $this->middlewaresToLoad[] = $route;
+                }
             }
 
             $this->currentRoute = null;
@@ -131,6 +136,12 @@ class RouterBase {
         // Loop through each route-request
         $this->processRoutes($this->routes);
 
+        // Load group middlewares
+        /* @var $route RouterEntry */
+        foreach($this->middlewaresToLoad as $route) {
+            $route->loadMiddleware($this->request);
+        }
+
         $routeNotAllowed = false;
 
         // Make sure routes with longer urls are rendered first
@@ -180,14 +191,15 @@ class RouterBase {
         }
 
         if(!$this->request->loadedRoute) {
-            throw new RouterException(sprintf('Route not found: %s', $this->request->getUri()), 404);
+            $this->handleException(new RouterException(sprintf('Route not found: %s', $this->request->getUri()), 404));
         }
     }
 
     protected function handleException(\Exception $e) {
-        if($this->request->loadedRoute !== null && $this->request->loadedRoute->exceptionHandler !== null) {
-            $handler = new $this->request->loadedRoute->exceptionHandler();
-            if(!($handler instanceof IExceptionHandler)) {
+
+        foreach ($this->exceptionHandlers as $handler) {
+            $handler = new $handler($this->request);
+            if (!($handler instanceof IExceptionHandler)) {
                 throw new RouterException('Exception handler must implement the IExceptionHandler interface.');
             }
 
@@ -206,9 +218,11 @@ class RouterBase {
 
     /**
      * @param string $defaultNamespace
+     * @return static
      */
     public function setDefaultNamespace($defaultNamespace) {
         $this->defaultNamespace = $defaultNamespace;
+        return $this;
     }
 
     /**
@@ -291,8 +305,8 @@ class RouterBase {
     public function arrayToParams(array $getParams = null, $includeEmpty = true) {
         if (is_array($getParams) && count($getParams) > 0) {
             foreach ($getParams as $key => $val) {
-                if (!empty($val) || empty($val) && $includeEmpty) {
-                    $getParams[$key] = $key . '=' . $val;
+                if (!empty($val) || $includeEmpty) {
+                    $getParams[$key] = (is_array($val) ? $this->arrayToParams($val, $includeEmpty) : $key . '=' . $val);
                 }
             }
             return join('&', $getParams);
@@ -300,7 +314,7 @@ class RouterBase {
         return '';
     }
 
-    protected function processUrl($route, $method = null, $parameters = null, $getParams = null) {
+    protected function processUrl(RouterRoute $route, $method = null, $parameters = null, $getParams = null) {
 
         $domain = '';
 

src/Pecee/SimpleRouter/RouterRoute.php

@@ -103,11 +103,9 @@ class RouterRoute extends RouterEntry {
                 }
             }
         } else {
-            if(strtolower($this->getAlias()) === strtolower($name)) {
-                return true;
-            }
+            return strtolower($this->getAlias()) === strtolower($name);
         }
-
+        
         return false;
     }
 

src/Pecee/SimpleRouter/SimpleRouter.php

@@ -19,9 +19,7 @@ class SimpleRouter {
      * @throws \Pecee\Exception\RouterException
      */
     public static function start($defaultNamespace = null) {
-        $router = RouterBase::getInstance();
-        $router->setDefaultNamespace($defaultNamespace);
-        $router->routeRequest();
+        RouterBase::getInstance()->setDefaultNamespace($defaultNamespace)->routeRequest();
     }
 
     /**
@@ -37,47 +35,19 @@ class SimpleRouter {
     }
 
     public static function get($url, $callback, array $settings = null) {
-        $route = new RouterRoute($url, $callback);
-        $route->addSettings($settings);
-        $route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_GET));
-
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
-
-        return $route;
+        return self::match(['get'], $url, $callback, $settings);
     }
 
     public static function post($url, $callback, array $settings = null) {
-        $route = new RouterRoute($url, $callback);
-        $route->addSettings($settings);
-        $route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_POST));
-
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
-
-        return $route;
+        return self::match(['post'], $url, $callback, $settings);
     }
 
     public static function put($url, $callback, array $settings = null) {
-        $route = new RouterRoute($url, $callback);
-        $route->addSettings($settings);
-        $route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_PUT, RouterRoute::REQUEST_TYPE_PATCH));
-
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
-
-        return $route;
+        return self::match(['put'], $url, $callback, $settings);
     }
 
     public static function delete($url, $callback, array $settings = null) {
-        $route = new RouterRoute($url, $callback);
-        $route->addSettings($settings);
-        $route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_DELETE));
-
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
-
-        return $route;
+        return self::match(['delete'], $url, $callback, $settings);
     }
 
     public static function group($settings = array(), $callback) {
@@ -88,8 +58,7 @@ class SimpleRouter {
             $group->setSettings($settings);
         }
 
-        $router = RouterBase::getInstance();
-        $router->addRoute($group);
+        RouterBase::getInstance()->addRoute($group);
 
         return $group;
     }
@@ -109,37 +78,48 @@ class SimpleRouter {
     public static function match(array $requestMethods, $url, $callback, array $settings = null) {
         $route = new RouterRoute($url, $callback);
         $route->setRequestMethods($requestMethods);
-        $route->addSettings($settings);
 
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
+        if($settings !== null) {
+            $route->addSettings($settings);
+        }
+
+        RouterBase::getInstance()->addRoute($route);
 
         return $route;
     }
 
     public static function all($url, $callback, array $settings = null) {
         $route = new RouterRoute($url, $callback);
-        $route->addSettings($settings);
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
+
+        if($settings !== null) {
+            $route->addSettings($settings);
+        }
+
+        RouterBase::getInstance()->addRoute($route);
 
         return $route;
     }
 
     public static function controller($url, $controller, array $settings = null) {
         $route = new RouterController($url, $controller);
-        $route->addSettings($settings);
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
+
+        if($settings !== null) {
+            $route->addSettings($settings);
+        }
+
+        RouterBase::getInstance()->addRoute($route);
 
         return $route;
     }
 
     public static function resource($url, $controller, array $settings = null) {
         $route = new RouterResource($url, $controller);
-        $route->addSettings($settings);
-        $router = RouterBase::getInstance();
-        $router->addRoute($route);
+
+        if($settings !== null) {
+            $route->addSettings($settings);
+        }
+
+        RouterBase::getInstance()->addRoute($route);
 
         return $route;
     }