RouteCollection.php

Constructor

Loads main routes file and discover routes. Loads only once unless reset.

Will attempt to discover any additional routes, either through the local PSR4 namespaces, or through selected Composer packages.

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.

For `spark routes`

Sets the default namespace to use for Controllers when no other namespace has been specified.

Sets the default controller to use when no other controller has been specified.

Sets the default method to call on the controller when no other method has been set in the route.

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....

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.

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.

Returns the 404 Override setting, which can be null, a closure or the controller/string.

Sets the default constraint to be used in the system. Typically for use with the 'resource' method.

Returns the name of the default controller. With Namespace.

Returns the name of the default method to use within the controller.

Returns the default namespace as set in the Routes config file.

Returns the current value of the translateURIDashes setting.

Returns the flag that tells whether to autoRoute URI against Controllers.

Returns the raw array of available routes.

Returns one or all routes options

Returns the current HTTP Verb being used.

Sets the current HTTP verb. Used primarily for testing.

A shortcut method to add a number of routes at a single time. It does not allow any options to be set on the route, or to define the method used.

Adds a single route to the collection. Example: $routes->add('news', 'Posts::index');

Adds a temporary redirect from one route to another. Used for redirecting traffic from old, non-existing routes to the new moved routes.

Determines if the route is a redirecting route.

Grabs the HTTP status code from a redirecting Route.

Group a series of routes under a single URL segment. This is handy for grouping items into an admin area, like: Example: Creates route: admin/users $route->group('admin', function() { $route->resource('users'); });

Creates a collections of HTTP-verb based routes for a controller. Possible Options: 'controller' - Customize the name of the controller used in the 'to' route 'placeholder' - The regex used by the Router. Defaults to '(:any)' 'websafe' - - '1' if only GET and POST HTTP verbs are supported Example: $route->resource('photos'); Generates the following routes: HTTP Verb | Path | Action | Used for... ----------+-------------+---------------+----------------- GET /photos index an array of photo objects GET /photos/new new an empty photo object, with default properties GET /photos/{id}/edit edit a specific photo object, editable properties GET /photos/{id} show a specific photo object, all properties POST /photos create a new photo object, to add to the resource DELETE /photos/{id} delete deletes the specified photo object PUT/PATCH /photos/{id} update replacement properties for existing photo If 'websafe' option is present, the following paths are also available: POST /photos/{id}/delete delete POST /photos/{id} update

Creates a collections of HTTP-verb based routes for a presenter controller. Possible Options: 'controller' - Customize the name of the controller used in the 'to' route 'placeholder' - The regex used by the Router. Defaults to '(:any)' Example: $route->presenter('photos'); Generates the following routes: HTTP Verb | Path | Action | Used for... ----------+-------------+---------------+----------------- GET /photos index showing all array of photo objects GET /photos/show/{id} show showing a specific photo object, all properties GET /photos/new new showing a form for an empty photo object, with default properties POST /photos/create create processing the form for a new photo GET /photos/edit/{id} edit show an editing form for a specific photo object, editable properties POST /photos/update/{id} update process the editing form data GET /photos/remove/{id} remove show a form to confirm deletion of a specific photo object POST /photos/delete/{id} delete deleting the specified photo object

Specifies a single route to match for multiple HTTP Verbs. Example: $route->match( ['GET', 'POST'], 'users/(:num)', 'users/$1);

Specifies a route that is only available to GET requests.

Specifies a route that is only available to POST requests.

Specifies a route that is only available to PUT requests.

Specifies a route that is only available to DELETE requests.

Specifies a route that is only available to HEAD requests.

Specifies a route that is only available to PATCH requests.

Specifies a route that is only available to OPTIONS requests.

Specifies a route that is only available to command-line requests.

Specifies a route that will only display a view. Only works for GET requests.

Limits the routes to a specified ENVIRONMENT or they won't run.

Attempts to look up a route based on its 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); The last parameter allows you to set the locale.

Replaces the {locale} tag with the current application locale

Checks a route (using the "from") to see if it's filtered or not.

Returns the filters that should be applied for a single route, along with any parameters it might have. Parameters are found by splitting the parameter name on a colon to separate the filter name from the parameter list, and the splitting the result on commas. So: 'role:admin,manager' has a filter of "role", with parameters of ['admin', 'manager'].

Given a

Builds reverse route The last parameter allows you to set the locale.

Replaces the {locale} tag with the locale

Does the heavy lifting of creating an actual route. You must specify the request method(s) that this route will work for. They can be separated by a pipe character "|" if there is more than one.

Compares the hostname passed in against the current hostname on this page request.

Returns the method param string like `/$1/$2` for placeholders

Compares the subdomain(s) passed in against the current subdomain on this page request.

Examines the HTTP_HOST to get the best match for the subdomain. It won't be perfect, but should work for our needs. It's especially not perfect since it's possible to register a domain with a period (.) as part of the domain name.

Reset the routes, so that a test case can provide the explicit ones needed for it.

Load routes options based on verb string, array{ filter?: list<string>|string, namespace?: string, hostname?: string, subdomain?: string, offset?: int, priority?: int, as?: string, redirect?: int } >

Enable or Disable sorting routes by priority

Get all controllers in Route Handlers `'*'` returns all controllers in any verb.

Set The flag that limit or not the routes with {locale} placeholder to App::$supportedLocales

Get the flag that limit or not the routes with {locale} placeholder to App::$supportedLocales