2.2

Author: miladrahimi

README.md

@@ -31,19 +31,23 @@ If you are not familiar with Composer, The article
 can be useful.
 After installing Composer, go to your project directory and run following command there:
 ```
-php composer.phar require miladrahimi/phprouter
+composer require miladrahimi/phprouter
 ```
 Or if you have `composer.json` file already in your application,
 you may add this package to your application requirements
 and update your dependencies:
 ```
 "require": {
-    "miladrahimi/phprouter": "dev-master"
+    "miladrahimi/phprouter": "~2.2"
 }
 ```
 ```
-php composer.phar update
+composer update
 ```
+#### Using PHPVendor
+If you don't use Composer you may use [PHPVendor](https://github.com/miladrahimi/phpvendor).
+Copy `src` directory content in your application vendor directory,
+then include the `phpvendor.php` in your application.
 #### Manually
 You can use your own autoloader as long as it follows [PSR-0](http://www.php-fig.org/psr/psr-0) or
 [PSR-4](http://www.php-fig.org/psr/psr-4) standards.

composer.json

@@ -21,8 +21,6 @@
         "php": ">=5.3.0"
     },
     "autoload": {
-        "psr-4": {
-        	"MiladRahimi\\": "src/MiladRahimi/"
-        }
+        "psr-4": {"MiladRahimi\\": "src/MiladRahimi/"}
     }
 }

src/MiladRahimi/PHPRouter/HttpError.php

@@ -2,12 +2,10 @@
 
 /**
  * Class HttpError
- *
  * HttpError Exception would be thrown when HTTP error occurs. The exception
  * message would be HTTP error code like 404 for HTTP 404 Not Found error.
  *
  * @package MiladRahimi\PHPRouter
- *
  * @author Milad Rahimi <[email protected]>
  */
 class HttpError extends \Exception

src/MiladRahimi/PHPRouter/InvalidArgumentException.php

@@ -0,0 +1,13 @@
+<?php namespace MiladRahimi\PHPRouter;
+
+/**
+ * Class InvalidArgumentException
+ * Specified InvalidArgumentException exception for the package
+ *
+ * @package MiladRahimi\PHPConfig
+ * @author Milad Rahimi <[email protected]>
+ */
+class InvalidArgumentException extends \InvalidArgumentException
+{
+    // Not implemented yet!
+}

src/MiladRahimi/PHPRouter/PHPRouterError.php

@@ -2,11 +2,9 @@
 
 /**
  * Class PHPRouterError
- *
- * PHPRouterError Exception is the main error exception for whole the package.
+ * The main package exception
  *
  * @package MiladRahimi\PHPRouter
- *
  * @author Milad Rahimi <[email protected]>
  */
 class PHPRouterError extends \Exception

src/MiladRahimi/PHPRouter/Request.php

@@ -2,13 +2,11 @@
 
 /**
  * Class Request
- *
  * Request Class is used to get user HTTP request information. Whole the project
  * would have only one instance (singleton pattern) an that is an optional
  * parameter for controller method, function to closure.
  *
  * @package MiladRahimi\PHPRouter
- *
  * @author Milad Rahimi <[email protected]>
  */
 class Request
@@ -120,12 +118,12 @@ class Request
     private $get;
 
     /**
-     * @param Router $router
+     * Constructor
+     *
+     * @param Router $router : Router object
      */
     private function __construct(Router $router)
     {
-        if (!($router instanceof Router))
-            throw new \InvalidArgumentException("Neatplex PHPRouter: Invalid object given instead of Router object");
         $this->router = $router;
         $u = $this->uri = urldecode($_SERVER["REQUEST_URI"]);
         $q = $this->query_string = $_SERVER["QUERY_STRING"];
@@ -150,10 +148,9 @@ private function __construct(Router $router)
      * Get singleton instance of the class
      *
      * @param Router $router
-     *
      * @return Request
      */
-    public static function getInstance(Router $router = null)
+    public static function getInstance(Router $router)
     {
         return isset(self::$instance) ? self::$instance : self::$instance = new Request($router);
     }
@@ -197,16 +194,16 @@ public function get($key = null)
     /**
      * Return the user HTTP request POST
      *
-     * @param string $key
-     *
+     * @param string $name
      * @return array
      */
-    public function post($key = null)
+    public function post($name = null)
     {
-        if (is_null($key))
+        if (is_null($name))
             return $this->post;
-        $post = $this->post;
-        return isset($post[$key]) ? $post[$key] : null;
+        if(!is_scalar($name))
+            throw new InvalidArgumentException("Name must be a string value");
+        return isset($this->post[$name]) ? $this->post[$name] : null;
     }
 
     /**
@@ -285,13 +282,14 @@ public function getPage()
      * Request cookies (Read-only)
      *
      * @param string $name
-     *
      * @return array
      */
     public function cookie($name = null)
     {
         if (is_null($name))
             return $_COOKIE;
+        if(!is_scalar($name))
+            throw new InvalidArgumentException("Name must be a string value");
         return isset($_COOKIE[$name]) ? $_COOKIE[$name] : null;
     }
 

src/MiladRahimi/PHPRouter/Response.php

@@ -2,12 +2,10 @@
 
 /**
  * Class Response
- *
  * Response Class is used to help developer to response the matched route, it
  * includes methods like redirect(), render(), etc.
  *
  * @package MiladRahimi\PHPRouter
- *
  * @author Milad Rahimi <[email protected]>
  */
 class Response
@@ -43,10 +41,9 @@ private function __construct(Router $rooter)
      * Get singleton instance of the class
      *
      * @param Router $router
-     *
      * @return Request
      */
-    public static function getInstance(Router $router = null)
+    public static function getInstance(Router $router)
     {
         return isset(self::$instance) ? self::$instance : self::$instance = new Response($router);
     }
@@ -58,6 +55,8 @@ public static function getInstance(Router $router = null)
      */
     public function redirect($to = "/")
     {
+        if (!is_scalar($to))
+            throw new InvalidArgumentException("To must be a string value");
         $to = $this->router->getBaseURI() . (is_string($to) ? $to : "");
         ob_start();
         ob_clean();
@@ -76,12 +75,19 @@ public function __toString()
     /**
      * Render (PHP) file
      *
-     * @param string $file
+     * @param string $file : PHP file to render
+     * @throws InvalidArgumentException
+     * @throws PHPRouterError
      */
-    public function render($file = null)
+    public function render($file)
     {
-        if (file_exists($file))
-            include $file;
+        if (!is_scalar($file))
+            throw new InvalidArgumentException("File must be a string value");
+        if (file_exists($file)) {
+            require $file;
+        } else {
+            throw new PHPRouterError("File does not exist");
+        }
     }
 
 
@@ -100,8 +106,10 @@ public function render($file = null)
      */
     public function cookie($name, $value, $expire = 0, $path = null, $domain = null, $secure = false, $httponly = false)
     {
-        if (empty($name) || empty($value))
-            throw new \InvalidArgumentException("cookie() method catches empty name or value parameter");
+        if (!isset($name) || !is_scalar($name))
+            throw new InvalidArgumentException("Name must be a string value");
+        if (!isset($value))
+            throw new InvalidArgumentException("Value must be set");
         return setcookie($name, $value, $expire, $path, $domain, $secure, $httponly);
     }
 
@@ -122,6 +130,8 @@ public function contents()
      */
     public function publish($content)
     {
+        if (!isset($content))
+            throw new InvalidArgumentException("Content must be set");
         // Open output stream
         $fp = fopen("php://output", 'r+');
         // Raw content

src/MiladRahimi/PHPRouter/Router.php

@@ -2,12 +2,10 @@
 
 /**
  * Class Router
- *
  * Router class is the main class which developers must interactive with to
  * dispatch all website routes.
  *
  * @package MiladRahimi\PHPRouter
- *
  * @author Milad Rahimi <[email protected]>
  */
 class Router
@@ -92,15 +90,16 @@ class Router
     private $response;
 
     /**
-     * @param string $base_uri
+     * Constructor
      *
+     * @param string $base_uri
      * @throw \InvalidArgumentException
      */
     public function __construct($base_uri = "")
     {
         // Set Base URI
         if (!is_string($base_uri))
-            throw new \InvalidArgumentException('Neatplex PHPRouter: $base_uri must be a string value');
+            throw new InvalidArgumentException("Base URI must be a string value");
         $this->base_uri = $base_uri;
         // New Request
         $this->request = Request::getInstance($this);
@@ -120,11 +119,14 @@ public function __toString()
      *
      * @param array|callable|string $options
      * @param callable $body
-     *
      * @throws PHPRouterError
      */
     public function group($options, $body)
     {
+        if (!isset($options))
+            throw new InvalidArgumentException("Options must be set");
+        if (!isset($body))
+            throw new InvalidArgumentException("Body must be set");
         if (is_array($options)) {
             if (isset($options["middleware"]))
                 if (!is_array($options["middleware"]))
@@ -235,7 +237,6 @@ private function checkBaseURI()
      * Convert route to regex pattern and extract the parameters
      *
      * @param string $route Route ro compile
-     *
      * @return string Pattern
      */
     private function convertToRegex($route)
@@ -247,9 +248,7 @@ private function convertToRegex($route)
      * Check whether the set domain is correct or not
      *
      * @param string $domain Set Domain
-     *
      * @return array arguments
-     *
      * @throws HttpError
      */
     private function checkDomain($domain)
@@ -267,7 +266,6 @@ private function checkDomain($domain)
      *
      * @param callable $function
      * @param array $arguments
-     *
      * @return array
      */
     private function arrangeFuncArgs($function, $arguments)
@@ -293,7 +291,6 @@ function (\ReflectionParameter $param) use ($arguments) {
      * @param object $class
      * @param callable $method
      * @param array $arguments
-     *
      * @return array
      */
     private function arrangeMethodArgs($class, $method, $arguments)
@@ -344,11 +341,16 @@ public function get($routes = null, $controller = null, $middleware = null)
      * @param string|array $routes
      * @param string|callable $controller
      * @param callable|string|null $middleware
-     *
      * @throws PHPRouterError
      */
     public function map($methods, $routes, $controller, $middleware = null)
     {
+        if (!isset($methods))
+            throw new InvalidArgumentException("Methods must be set");
+        if (!isset($routes))
+            throw new InvalidArgumentException("Routes must be set");
+        if (!isset($controller))
+            throw new InvalidArgumentException("Controllers must be set");
         if (!is_array($methods))
             $methods = array($methods);
         if (!is_array($routes))
@@ -377,7 +379,6 @@ public function map($methods, $routes, $controller, $middleware = null)
      * Escape undesired regex from the given content
      *
      * @param string $content
-     *
      * @return string
      */
     private function safeRegex($content)
@@ -416,15 +417,14 @@ public function post($routes = null, $controller = null, $middleware = null)
      *
      * @param string $parameter_name Desired parameter for changing it's regex pattern
      * @param string $regex Desired regex pattern for related parameter
-     *
      * @throw \InvalidArgumentException
      */
     public function define($parameter_name, $regex)
     {
-        if (!is_string($parameter_name))
-            throw new \InvalidArgumentException('Neatplex PHPRouter: $parameter_name must be a string value');
-        if (!is_string($regex))
-            throw new \InvalidArgumentException('Neatplex PHPRouter: $regex must be a string value');
+        if (!isset($parameter_name) || !is_string($parameter_name))
+            throw new \InvalidArgumentException("Parameter name must be a string value");
+        if (!isset($regex) || !is_string($regex))
+            throw new \InvalidArgumentException("Regex must be a string value");
         $this->parameters[$parameter_name] = $this->safeRegex($regex);
     }
 
@@ -440,7 +440,6 @@ public function getBaseURI()
      * Return the regex pattern of given parameter
      *
      * @param string $name Parameter Name
-     *
      * @return string Pattern
      */
     private function regexParameter($name)