ingeniasoftware / luthier

src/Core/Route.php

Doc Comments +13 added lines, -19 removed lines

@@ -119,7 +119,6 @@ 
      * Generic method to add a improved route
      *
      * @param  mixed $verb String or array of string of valid HTTP Verbs that will be accepted in this route
-     * @param  mixed $url String or array of strings that will trigger this route
      * @param  array $attr Associative array of route attributes
      * @param  bool $hideOriginal (Optional) map the original $url as a route with a show_404() callback inside
      *
@@ -273,7 +272,7 @@ 
     /**
      * Adds a GET route, alias of Route::add('GET',$url,$attr,$hideOriginal)
      *
-     * @param  mixed $url String or array of strings that will trigger this route
+     * @param  string $url String or array of strings that will trigger this route
      * @param  array $attr Associative array of route attributes
      * @param  bool $hideOriginal (Optional) map the original $url as a route with a show_404() callback inside
      *
@@ -290,7 +289,7 @@ 
     /**
      * Adds a POST route, alias of Route::add('POST',$url,$attr,$hideOriginal)
      *
-     * @param  mixed $url String or array of strings that will trigger this route
+     * @param  string $url String or array of strings that will trigger this route
      * @param  array $attr Associative array of route attributes
      * @param  bool $hideOriginal (Optional) map the original $url as a route with a show_404() callback inside
      *
@@ -341,7 +340,7 @@ 
     /**
      * Adds a DELETE route, alias of Route::add('DELETE',$url,$attr,$hideOriginal)
      *
-     * @param  mixed $url String or array of strings that will trigger this route
+     * @param  string $url String or array of strings that will trigger this route
      * @param  array $attr Associative array of route attributes
      * @param  bool $hideOriginal (Optional) map the original $url as a route with a show_404() callback inside
      *
@@ -379,8 +378,8 @@ 
     /**
      * Adds a list of routes with the verbs contained in $verbs, alias of Route::add($verbs,$url,$attr,$hideOriginal)
      *
-     * @param  mixed $verb String or array of string of valid HTTP Verbs that will be accepted in this route
-     * @param  mixed $url String or array of strings that will trigger this route
+     * @param  string[] $verbs String or array of string of valid HTTP Verbs that will be accepted in this route
+     * @param  string $url String or array of strings that will trigger this route
      * @param  array $attr Associative array of route attributes
      * @param  bool $hideOriginal (Optional) map the original $url as a route with a show_404() callback inside
      *
@@ -414,7 +413,6 @@ 
      *
      * PLEASE NOTE: This is NOT a crud generator, just a bundle of predefined routes.
      *
-     * @param  string $url String or array of strings that will trigger this route
      * @param  string $controller Controller name (only controller name)
      * @param  array $attr Associative array of route attributes
      *
@@ -709,10 +707,6 @@ 
     /**
      * Creates the 'default_controller' key in CodeIgniter's route array
      *
-     * @param  string $route controller/method name
-     * @param  string $alias (Optional) alias of the default controller
-     *
-     * Due a CodeIgniter limitations, this route MAY NOT be a directory.
      *
      * @return void
      *
@@ -770,7 +764,7 @@ 
     /**
      * Get all the improved routes defined
      *
-     * @return array List of all defined routes
+     * @return Route List of all defined routes
      *
      * @access public
      * @static
@@ -783,7 +777,7 @@ 
     /**
      * Get all hidden routes
      *
-     * @return array
+     * @return Route
      *
      * @access public
      * @static
@@ -799,7 +793,7 @@ 
      * This middleware actually works as uri filter since they will not check the route,
      * just check if the current uri string matches the prefix of the route group.
      *
-     * @return array
+     * @return Route
      *
      * @access public
      * @static
@@ -837,8 +831,9 @@ 
      *  This is the 'reverse' process of the improved routing, it'll take the current
      *  uri string and attempts to find a CodeIgniter route that matches with his pattern
      *
-     * @param  string $search The current uri string
      *
+     * @param Middleware $path
+     * @param string $requestMethod
      * @return mixed
      */
     public static function getRouteByPath($path, $requestMethod = NULL)
@@ -888,7 +883,7 @@ 
     /**
      * Returns an array with the valid HTTP Verbs used in routes
      *
-     * @return array
+     * @return Route
      *
      * @access public
      * @static
@@ -903,7 +898,6 @@ 
      * Set the 404 error controller ($route['404_override'])
      *
      * @param  string  $controller
-     * @param  string  $namespace (Optional)
      *
      * @return void
      *
@@ -922,9 +916,9 @@ 
     /**
      * Get the 404 route
      *
-     * @return array $_404page
+     * @return Route $_404page
      *
-     * @return object | null
+     * @return Route | null
      *
      * @access public
      * @static

Braces +108 added lines, -80 removed lines

@@ -148,11 +148,13 @@ 
         $controller = $parsedController[1];
         $method     = $parsedController[2];
 
-        if(!is_string($path))
-            show_error('Route path must be a string ', 500, 'Route error: bad route path');
+        if(!is_string($path)) {
+                    show_error('Route path must be a string ', 500, 'Route error: bad route path');
+        }
 
-        if(!is_string($verb))
-            show_error('Route HTTP Verb must be a string', 500, 'Route error: bad verb type');
+        if(!is_string($verb)) {
+                    show_error('Route HTTP Verb must be a string', 500, 'Route error: bad verb type');
+        }
 
         $verb = strtoupper($verb);
 
@@ -181,38 +183,47 @@ 
         if(isset($attr['as']))
         {
             $route['name'] = $attr['as'];
-        }
-        else
+        } else
         {
             $route['name'] = NULL;
         }
 
         $route['prefix'] = NULL;
 
-        if(!is_null(self::$prefix))
-            $route['prefix'] = self::$prefix;   # Group
-        if(isset($attr['prefix']))
-            $route['prefix'] = $attr['prefix']; # Specific (will overwrite group prefix)
+        if(!is_null(self::$prefix)) {
+                    $route['prefix'] = self::$prefix;
+        }
+        # Group
+        if(isset($attr['prefix'])) {
+                    $route['prefix'] = $attr['prefix'];
+        }
+        # Specific (will overwrite group prefix)
 
         $route['namespace'] = NULL;
 
-        if(!is_null(self::$namespace))
-            $route['namespace'] = self::$namespace;   # Group
-        if(isset($attr['namespace']))
-            $route['namespace'] = $attr['namespace']; # Specific (will overwrite group namespace)
+        if(!is_null(self::$namespace)) {
+                    $route['namespace'] = self::$namespace;
+        }
+        # Group
+        if(isset($attr['namespace'])) {
+                    $route['namespace'] = $attr['namespace'];
+        }
+        # Specific (will overwrite group namespace)
 
         # Removing trailing slashes
         if(!is_null($route['prefix']))
         {
             $route['prefix'] = trim($route['prefix'],'/');
-            if($route['prefix'] == '')
-                $route['prefix'] = NULL;
+            if($route['prefix'] == '') {
+                            $route['prefix'] = NULL;
+            }
         }
         if(!is_null($route['namespace']))
         {
             $route['namespace'] = trim($route['namespace'],'/');
-            if($route['namespace'] == '')
-                $route['namespace'] = NULL;
+            if($route['namespace'] == '') {
+                            $route['namespace'] = NULL;
+            }
         }
 
         $route['middleware'] = array();
@@ -221,14 +232,14 @@ 
         {
             if(is_array($attr['middleware']))
             {
-                foreach($attr['middleware'] as $middleware)
-                    $route['middleware'][] = $middleware; # Group
-            }
-            elseif( is_string($attr['middleware']))
+                foreach($attr['middleware'] as $middleware) {
+                                    $route['middleware'][] = $middleware;
+                }
+                # Group
+            } elseif( is_string($attr['middleware']))
             {
                 $route['middleware'][] = $attr['middleware']; # Group
-            }
-            else
+            } else
             {
                 show_error('Route middleware must be a string or an array',500,'Route error: bad middleware format');
             }
@@ -263,8 +274,7 @@ 
         if(!$return)
         {
             self::$routes[] = (object) $route;
-        }
-        else
+        } else
         {
             return (object) $route;
         }
@@ -391,8 +401,9 @@ 
      */
     public static function matches($verbs, $url, $attr, $hideOriginal = FALSE)
     {
-        if(!is_array($verbs))
-            show_error('Route::matches() first argument must be an array of valid HTTP Verbs', 500, 'Route error: bad Route::matches() verb list');
+        if(!is_array($verbs)) {
+                    show_error('Route::matches() first argument must be an array of valid HTTP Verbs', 500, 'Route error: bad Route::matches() verb list');
+        }
 
         foreach($verbs as $verb)
         {
@@ -429,17 +440,21 @@ 
 
         $hideOriginal = FALSE;
 
-        if(isset($attr['namespace']))
-            $base_attr['namespace']  = $attr['namespace'];
+        if(isset($attr['namespace'])) {
+                    $base_attr['namespace']  = $attr['namespace'];
+        }
 
-        if(isset($attr['middleware']))
-            $base_attr['middleware'] = $attr['middleware'];
+        if(isset($attr['middleware'])) {
+                    $base_attr['middleware'] = $attr['middleware'];
+        }
 
-        if(isset($attr['hideOriginal']))
-            $hideOriginal = (bool) $attr['hideOriginal'];
+        if(isset($attr['hideOriginal'])) {
+                    $hideOriginal = (bool) $attr['hideOriginal'];
+        }
 
-        if(isset($attr['prefix']))
-            $base_attr['prefix']  = $attr['prefix'];
+        if(isset($attr['prefix'])) {
+                    $base_attr['prefix']  = $attr['prefix'];
+        }
 
         $only = array();
 
@@ -448,8 +463,7 @@ 
             if(is_array($attr['only']))
             {
                 $only  = strtolower($attr['only']);
-            }
-            else
+            } else
             {
                 $only[] = strtolower($attr['only']);
             }
@@ -525,16 +539,19 @@ 
 
         $path = $route->path;
 
-        if(!is_null($prefix))
-            $path = $prefix.'/'.$path;
+        if(!is_null($prefix)) {
+                    $path = $prefix.'/'.$path;
+        }
 
-        if(substr($path, 0, 1) == "/" && strlen($path) > 1)
-            $path = substr($path,1);
+        if(substr($path, 0, 1) == "/" && strlen($path) > 1) {
+                    $path = substr($path,1);
+        }
 
         $controller = $route->controller.'/'.$route->method;
 
-        if(!is_null($namespace))
-            $controller = $namespace.'/'.$controller;
+        if(!is_null($namespace)) {
+                    $controller = $namespace.'/'.$controller;
+        }
 
         $replaces =
             [
@@ -600,12 +617,14 @@ 
             $path = key($route);
             $_404 = $route[$path];
 
-            if(!isset($routes[$path]))
-                $routes[$path] = $_404;
+            if(!isset($routes[$path])) {
+                            $routes[$path] = $_404;
+            }
         }
 
-        if(is_null(self::$defaultController))
-            show_error('You must specify a home route: Route::home() as default controller!', 500, 'Route error: missing default controller');
+        if(is_null(self::$defaultController)) {
+                    show_error('You must specify a home route: Route::home() as default controller!', 500, 'Route error: missing default controller');
+        }
 
         $defaultController = self::$defaultController->compiled;
         $defaultController = $defaultController[key($defaultController)];
@@ -615,8 +634,7 @@ 
         if(is_null(self::$_404page))
         {
             $routes['404_override'] = '';
-        }
-        else
+        } else
         {
             $routes['404_override'] = self::$_404page->controller;
         }
@@ -639,11 +657,13 @@ 
      */
     public static function group($attr, $routes)
     {
-        if(!is_array($attr))
-            show_error('Group attribute must be a valid array');
+        if(!is_array($attr)) {
+                    show_error('Group attribute must be a valid array');
+        }
 
-        if(!isset($attr['prefix']))
-            show_error('You must specify an prefix!');
+        if(!isset($attr['prefix'])) {
+                    show_error('You must specify an prefix!');
+        }
 
         self::$prefix = $attr['prefix'];
 
@@ -655,8 +675,7 @@ 
         if(isset($attr['hideOriginals']) && $attr['hideOriginals'] === TRUE)
         {
             self::$hideOriginals = TRUE;
-        }
-        else
+        } else
         {
             self::$hideOriginals = FALSE;
         }
@@ -668,15 +687,14 @@ 
                 //self::$middleware = $attr['middleware'];
                 if(is_array($attr['middleware']) && !empty($attr['middleware']))
                 {
-                    foreach($attr['middleware'] as $middleware)
-                        self::$groupMiddleware[] = [ $attr['prefix'] => $middleware ];
-                }
-                else
+                    foreach($attr['middleware'] as $middleware) {
+                                            self::$groupMiddleware[] = [ $attr['prefix'] => $middleware ];
+                    }
+                } else
                 {
                     self::$groupMiddleware[] = [ $attr['prefix'] => $attr['middleware'] ];
                 }
-            }
-            else
+            } else
             {
                 show_error('Group middleware not valid');
             }
@@ -691,8 +709,10 @@ 
             $controller = $uri[0];
             $method = isset($uri[1]) ? $uri[1] : NULL;
 
-            if(self::$hideOriginals === TRUE)
-                self::$hiddenRoutes[] = [$controller => function(){ show_404(); }];
+            if(self::$hideOriginals === TRUE) {
+                            self::$hiddenRoutes[] = [$controller => function(){ show_404();
+            }
+            }];
 
             $route_attr['uses'] = $controller.( !is_null($method) ? '/'.$method : '');
             self::get('/', $route_attr);
@@ -727,14 +747,17 @@ 
                 'as'   => $as
             ];
 
-        if(!is_null($attr) && !is_array($attr))
-            show_error('Default controller attributes must be an array',500,'Route error: bad attribute type');
+        if(!is_null($attr) && !is_array($attr)) {
+                    show_error('Default controller attributes must be an array',500,'Route error: bad attribute type');
+        }
 
-        if(!is_null($attr))
-            $routeAttr = array_merge($routeAttr,$attr);
+        if(!is_null($attr)) {
+                    $routeAttr = array_merge($routeAttr,$attr);
+        }
 
-        if(isset($attr['prefix']))
-            show_error('Default controller may not have a prefix!',500,'Route error: prefix not allowed');
+        if(isset($attr['prefix'])) {
+                    show_error('Default controller may not have a prefix!',500,'Route error: prefix not allowed');
+        }
 
         self::$defaultController = self::$routes[] = self::add('GET', '/', ['uses' => $controller, 'as' => $as],TRUE, TRUE);
     }
@@ -824,8 +847,9 @@ 
     {
         foreach(self::$routes as $route)
         {
-            if($route->name == $search)
-                return base_url(self::compileRoute($route)->path);
+            if($route->name == $search) {
+                            return base_url(self::compileRoute($route)->path);
+            }
         }
 
         show_error('The route "'.$search.'" is not defined', 500, 'Route error');
@@ -850,14 +874,17 @@ 
             $routes[$route->verb][] = $route;
         }
 
-        if(empty($routes))
-            return FALSE;
+        if(empty($routes)) {
+                    return FALSE;
+        }
 
-        if(is_null($requestMethod))
-            $requestMethod = $_SERVER['REQUEST_METHOD'];
+        if(is_null($requestMethod)) {
+                    $requestMethod = $_SERVER['REQUEST_METHOD'];
+        }
 
-        if(!isset($routes[$requestMethod]))
-            return FALSE;
+        if(!isset($routes[$requestMethod])) {
+                    return FALSE;
+        }
 
         $routes = $routes[$requestMethod];
 
@@ -877,8 +904,9 @@ 
             {
                 $compiled = $route->compiled;
 
-                if($findPath == key($compiled))
-                    return $route;
+                if($findPath == key($compiled)) {
+                                    return $route;
+                }
             }
         }
 

src/Middleware/Request.php

Braces +17 added lines, -18 removed lines

@@ -64,20 +64,22 @@ 
 
         // FIXME: Solve ambiguity here! POST with _method="GET" makes no sense
 
-        if(isset($_POST['_method']) && in_array(strtoupper($_POST['_method']), $validMethods , TRUE))
-            $formMethod = strtoupper($_POST['_method']);
+        if(isset($_POST['_method']) && in_array(strtoupper($_POST['_method']), $validMethods , TRUE)) {
+                    $formMethod = strtoupper($_POST['_method']);
+        }
 
         if(is_null($formMethod))
         {
             $this->requestMethod = $requestMethod;
-        }
-        else
+        } else
         {
-            if($requestMethod == 'POST')
-                $this->requestMethod = $formMethod;
+            if($requestMethod == 'POST') {
+                            $this->requestMethod = $formMethod;
+            }
 
-            if(!$this->CI->input->is_ajax_request() && $this->requestMethod == 'HEAD')
-                $this->requestMethod = 'POST';
+            if(!$this->CI->input->is_ajax_request() && $this->requestMethod == 'HEAD') {
+                            $this->requestMethod = 'POST';
+            }
         }
     }
 
@@ -92,22 +94,21 @@ 
     {
         if(!$this->route)
         {
-            if(is_null(Route::get404()))
-                show_404();
+            if(is_null(Route::get404())) {
+                            show_404();
+            }
 
             if(Route::get404()->controller != get_class($this->CI))
             {
                 if(ENVIRONMENT != 'production')
                 {
                     show_error('The request method '.$this->requestMethod.' is not allowed to view the resource', 403, 'Forbidden method');
-                }
-                else
+                } else
                 {
                     redirect(Route::get404()->path);
                 }
             }
-        }
-        else
+        } else
         {
             if(method_exists($this->CI,$this->route->method))
             {
@@ -117,14 +118,12 @@ 
 
                 $this->CI->output->_display();
                 exit(0);
-            }
-            else
+            } else
             {
                 if(ENVIRONMENT != 'production')
                 {
                     show_error('The method '.$this->route->controller.'::'.$this->route->method.'() does not exists', 500, 'Method not found');
-                }
-                else
+                } else
                 {
                     redirect(Route::get404()->path);
                 }