add()
add(string $from, array|string $to, array $options = null) : mixed
Adds a single route to the collection.
Parameters
| string | $from | |
| array|string | $to | |
| array | $options |
Interface RouteCollectionInterface
A Route Collection's sole job is to hold a series of routes. The required number of methods is kept very small on purpose, but implementors may add a number of additional methods to customize how the routes are defined.
The RouteCollection provides the Router with the routes so that it can determine which controller should be ran.
addPlaceholder(string|array $placeholder, string $pattern = null) : mixed
Registers a new constraint with the system. Constraints are used by the routes as placeholders for regular expressions to make defining the routes more human-friendly.
You can pass an associative array as $placeholder, and have multiple placeholders added at once.
| string|array | $placeholder | |
| string | $pattern |
setTranslateURIDashes(boolean $value) : mixed
Tells the system whether to convert dashes in URI strings into underscores. In some search engines, including Google, dashes create more meaning and make it easier for the search engine to find words and meaning in the URI for better SEO. But it doesn't work well with PHP method names.
...
| boolean | $value |
setAutoRoute(boolean $value) : \CodeIgniter\Router\RouteCollectionInterface
If TRUE, the system will attempt to match the URI against Controllers by matching each segment against folders/files in APPPATH/Controllers, when a match wasn't found against defined routes.
If FALSE, will stop searching and do NO automatic routing.
| boolean | $value |
set404Override(callable|null $callable = null) : \CodeIgniter\Router\RouteCollectionInterface
Sets the class/method that should be called if routing doesn't find a match. It can be either a closure or the controller/method name exactly like a route is defined: Users::index
This setting is passed to the Router class and handled there.
| callable|null | $callable |
reverseRoute(string $search, array ...$params) : string|false
Attempts to look up a route based on it's destination.
If a route exists:
'path/(:any)/(:any)' => 'Controller::method/$1/$2'This method allows you to know the Controller and method and get the route that leads to it.
// Equals 'path/$param1/$param2'
reverseRoute('Controller::method', $param1, $param2);| string | $search | |
| array | $params variadic |