ingeniasoftware / luthier

src/Core/Route.php

Doc Comments +12 added lines, -18 removed lines

@@ -110,7 +110,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
      *
@@ -267,7 +266,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
      *
@@ -284,7 +283,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
      *
@@ -335,7 +334,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
      *
@@ -373,8 +372,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
      *
@@ -408,7 +407,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
      *
@@ -716,10 +714,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
      *
@@ -775,7 +769,7 @@ 
     /**
      * Get all hidden routes
      *
-     * @return array
+     * @return Route
      *
      * @access public
      * @static
@@ -791,7 +785,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
@@ -869,8 +863,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
      *
+     * @param Middleware $path
+     * @param string $requestMethod
      * @return mixed
      */
     public static function getRouteByPath($path, $requestMethod = NULL)
@@ -947,7 +942,7 @@ 
     /**
      * Returns an array with the valid HTTP Verbs used in routes
      *
-     * @return array
+     * @return Route
      *
      * @access public
      * @static
@@ -961,7 +956,6 @@ 
      * Set the 404 error controller ($route['404_override'])
      *
      * @param  string  $controller
-     * @param  string  $namespace (Optional)
      *
      * @return void
      *
@@ -980,9 +974,9 @@ 
     /**
      * Get the 404 route
      *
-     * @return array $_404page
+     * @return Route $_404page
      *
-     * @return object | null
+     * @return Route | null
      *
      * @access public
      * @static

Braces +106 added lines, -86 removed lines

@@ -140,11 +140,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);
 
@@ -170,8 +172,7 @@ 
         if(isset($attr['as']))
         {
             $route['name'] = $attr['as'];
-        }
-        else
+        } else
         {
             $route['name'] = NULL;
         }
@@ -181,30 +182,36 @@ 
         $route['prefix'] = NULL;
         $group_prefix = end(self::$prefix);
 
-        if($group_prefix)
-            $route['prefix'] = $group_prefix.'/';
+        if($group_prefix) {
+                    $route['prefix'] = $group_prefix.'/';
+        }
 
-        if(isset($attr['prefix']))
-            $route['prefix'] .= $attr['prefix'];
+        if(isset($attr['prefix'])) {
+                    $route['prefix'] .= $attr['prefix'];
+        }
 
         // Setting up the namespace
 
         $route['namespace'] = NULL;
         $group_namespace = end(self::$namespace);
 
-        if(!is_null($group_namespace))
-            $route['namespace'] = $group_namespace.'/';
-        if(isset($attr['namespace']))
-            $route['namespace'] .= $attr['namespace'];
+        if(!is_null($group_namespace)) {
+                    $route['namespace'] = $group_namespace.'/';
+        }
+        if(isset($attr['namespace'])) {
+                    $route['namespace'] .= $attr['namespace'];
+        }
 
         $route['prefix']    = trim($route['prefix'], '/');
         $route['namespace'] = trim($route['namespace'],'/');
 
-        if(empty($route['prefix']))
-            $route['prefix'] = NULL;
+        if(empty($route['prefix'])) {
+                    $route['prefix'] = NULL;
+        }
 
-        if(empty($route['namespace']))
-            $route['namespace'] = NULL;
+        if(empty($route['namespace'])) {
+                    $route['namespace'] = NULL;
+        }
 
         $route['middleware'] = array();
 
@@ -212,14 +219,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');
             }
@@ -257,8 +264,7 @@ 
         if(!$return)
         {
             self::$routes[] = (object) $route;
-        }
-        else
+        } else
         {
             return (object) $route;
         }
@@ -385,8 +391,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)
         {
@@ -423,19 +430,23 @@ 
 
         $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'];
+        }
 
         $base_attr['prefix'] = strtolower($name);
 
-        if(isset($attr['prefix']))
-            $base_attr['prefix']  = $attr['prefix'];
+        if(isset($attr['prefix'])) {
+                    $base_attr['prefix']  = $attr['prefix'];
+        }
 
         $only = array();
 
@@ -446,8 +457,7 @@ 
             if(is_array($attr['only']))
             {
                 $only  = $attr['only'];
-            }
-            else
+            } else
             {
                 $only[] = $attr['only'];
             }
@@ -523,8 +533,9 @@ 
 
         $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)
@@ -533,8 +544,9 @@ 
 
         $controller = $route->controller.'/'.$route->method;
 
-        if(!is_null($namespace))
-            $controller = $namespace.'/'.$controller;
+        if(!is_null($namespace)) {
+                    $controller = $namespace.'/'.$controller;
+        }
 
         $path       = trim($path,'/');
         $controller = trim($controller,'/');
@@ -572,11 +584,11 @@ 
             {
                 $args['optional'][] = $arg;
                 $argConstraint = TRUE;
-            }
-            else
+            } else
             {
-                if($argConstraint)
-                    show_error('Optional route path argument not valid at this position', 500, 'Route error');
+                if($argConstraint) {
+                                    show_error('Optional route path argument not valid at this position', 500, 'Route error');
+                }
                 $args['required'][] = $arg;
             }
         }
@@ -625,12 +637,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)];
@@ -640,8 +654,7 @@ 
         if(is_null(self::$_404page))
         {
             $routes['404_override'] = '';
-        }
-        else
+        } else
         {
             $routes['404_override'] = self::$_404page->controller;
         }
@@ -664,11 +677,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'];
 
@@ -680,8 +695,7 @@ 
         if(isset($attr['hideOriginals']) && $attr['hideOriginals'] === TRUE)
         {
             self::$hideOriginals[] = TRUE;
-        }
-        else
+        } else
         {
             self::$hideOriginals[] = FALSE;
         }
@@ -692,15 +706,14 @@ 
             {
                 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');
             }
@@ -734,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);
     }
@@ -759,14 +775,14 @@ 
         if(is_null($verb))
         {
             return self::$routes;
-        }
-        else
+        } else
         {
             $routes = [];
             foreach(self::$routes as $route)
             {
-                if($route->verb == $verb)
-                    $routes[] = $route;
+                if($route->verb == $verb) {
+                                    $routes[] = $route;
+                }
             }
             return $routes;
         }
@@ -875,21 +891,24 @@ 
      */
     public static function getRouteByPath($path, $requestMethod = NULL)
     {
-        if(is_null($requestMethod))
-            $requestMethod = $_SERVER['REQUEST_METHOD'];
+        if(is_null($requestMethod)) {
+                    $requestMethod = $_SERVER['REQUEST_METHOD'];
+        }
 
         $routes = self::getRoutes($requestMethod);
 
-        if(empty($routes))
-            return FALSE;
+        if(empty($routes)) {
+                    return FALSE;
+        }
 
         $founded = FALSE;
         $matches = array();
 
         $path = trim($path);
 
-        if($path == '')
-            return self::$defaultController;
+        if($path == '') {
+                    return self::$defaultController;
+        }
 
         $wildcards =
             [
@@ -916,10 +935,10 @@ 
 
                     if($mode == 'exact')
                     {
-                        if($findPath == $compiledPath)
-                            return $route;
-                    }
-                    else
+                        if($findPath == $compiledPath) {
+                                                    return $route;
+                        }
+                    } else
                     {
                         $e_findPath     = explode('/', $findPath);
                         $e_compiledPath = explode('/', $compiledPath);
@@ -933,8 +952,9 @@ 
 
                                 $valid = (bool) preg_match('#^'.$reg.'$#', $e_findPath[$i]);
                             }
-                            if($valid)
-                                return $route;
+                            if($valid) {
+                                                            return $route;
+                            }
                         }
                     }
                 }