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