/**
 * Constructor
 */

Defined in .../Router/RouteCollection.php:280

/**
 * Loads main routes file and discover routes.
 *
 * Loads only once unless reset.
 *
 * @return $this
 */

Defined in .../Router/RouteCollection.php:311

/**
 * Will attempt to discover any additional routes, either through
 * the local PSR4 namespaces, or through selected Composer packages.
 *
 * @return void
 */

Defined in .../Router/RouteCollection.php:353

/**
 * 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.
 *
 * @param array|string $placeholder
 */

Defined in .../Router/RouteCollection.php:389

/**
 * For `spark routes`
 *
 * @return array<string, string>
 *
 * @internal
 */

Defined in .../Router/RouteCollection.php:407

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

Defined in .../Router/RouteCollection.php:416

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

Defined in .../Router/RouteCollection.php:428

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

Defined in .../Router/RouteCollection.php:439

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

Defined in .../Router/RouteCollection.php:453

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

Defined in .../Router/RouteCollection.php:468

/**
 * 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.
 *
 * @param callable|string|null $callable
 */

Defined in .../Router/RouteCollection.php:484

/**
 * Returns the 404 Override setting, which can be null, a closure
 * or the controller/string.
 *
 * @return (Closure(string): (ResponseInterface|string|void))|string|null
 */

Defined in .../Router/RouteCollection.php:497

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

Defined in .../Router/RouteCollection.php:506

/**
 * Returns the name of the default controller. With Namespace.
 */

Defined in .../Router/RouteCollection.php:518

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

Defined in .../Router/RouteCollection.php:526

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

Defined in .../Router/RouteCollection.php:534

/**
 * Returns the current value of the translateURIDashes setting.
 */

Defined in .../Router/RouteCollection.php:542

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

Defined in .../Router/RouteCollection.php:550

/**
 * Returns the raw array of available routes.
 *
 * @param non-empty-string|null $verb            HTTP verb like `GET`,`POST` or `*` or `CLI`.
 * @param bool                  $includeWildcard Whether to include '*' routes.
 */

Defined in .../Router/RouteCollection.php:561

/**
 * Returns one or all routes options
 *
 * @param string|null $verb HTTP verb like `GET`,`POST` or `*` or `CLI`.
 *
 * @return array<string, int|string> [key => value]
 */

Defined in .../Router/RouteCollection.php:608

/**
 * Returns the current HTTP Verb being used.
 */

Defined in .../Router/RouteCollection.php:618

/**
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */

Defined in .../Router/RouteCollection.php:631

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

Defined in .../Router/RouteCollection.php:655

/**
 * Adds a single route to the collection.
 *
 * Example:
 *      $routes->add('news', 'Posts::index');
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:672

/**
 * Adds a temporary redirect from one route to another. Used for
 * redirecting traffic from old, non-existing routes to the new
 * moved routes.
 *
 * @param string $from   The pattern to match against
 * @param string $to     Either a route name or a URI to redirect to
 * @param int    $status The HTTP status code that should be returned with this redirect
 *
 * @return RouteCollection
 */

Defined in .../Router/RouteCollection.php:690

/**
 * Determines if the route is a redirecting route.
 *
 * @param string $routeKey routeKey or route name
 */

Defined in .../Router/RouteCollection.php:716

/**
 * Grabs the HTTP status code from a redirecting Route.
 *
 * @param string $routeKey routeKey or route name
 */

Defined in .../Router/RouteCollection.php:738

/**
 * 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');
 *     });
 *
 * @param string         $name      The name to group/prefix the routes with.
 * @param array|callable ...$params
 *
 * @return void
 */

Defined in .../Router/RouteCollection.php:770

/**
 * 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
 *
 * @param string     $name    The name of the resource/controller to route to.
 * @param array|null $options A list of possible ways to customize the routing.
 */

Defined in .../Router/RouteCollection.php:850

/**
 * 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
 *
 * @param string     $name    The name of the controller to route to.
 * @param array|null $options A list of possible ways to customize the routing.
 */

Defined in .../Router/RouteCollection.php:944

/**
 * Specifies a single route to match for multiple HTTP Verbs.
 *
 * Example:
 *  $route->match( ['GET', 'POST'], 'users/(:num)', 'users/$1);
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1018

/**
 * Specifies a route that is only available to GET requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1050

/**
 * Specifies a route that is only available to POST requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1062

/**
 * Specifies a route that is only available to PUT requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1074

/**
 * Specifies a route that is only available to DELETE requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1086

/**
 * Specifies a route that is only available to HEAD requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1098

/**
 * Specifies a route that is only available to PATCH requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1110

/**
 * Specifies a route that is only available to OPTIONS requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1122

/**
 * Specifies a route that is only available to command-line requests.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 */

Defined in .../Router/RouteCollection.php:1134

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

Defined in .../Router/RouteCollection.php:1145

/**
 * Limits the routes to a specified ENVIRONMENT or they won't run.
 *
 * @param Closure(RouteCollection): void $callback
 */

Defined in .../Router/RouteCollection.php:1164

/**
 * 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);
 *
 * @param string     $search    Route name or Controller::method
 * @param int|string ...$params One or more parameters to be passed to the route.
 *                              The last parameter allows you to set the locale.
 *
 * @return false|string The route (URI path relative to baseURL) or false if not found.
 */

Defined in .../Router/RouteCollection.php:1192

/**
 * Replaces the {locale} tag with the current application locale
 *
 * @deprecated Unused.
 */

Defined in .../Router/RouteCollection.php:1260

/**
 * Checks a route (using the "from") to see if it's filtered or not.
 *
 * @param string|null $verb HTTP verb like `GET`,`POST` or `*` or `CLI`.
 */

Defined in .../Router/RouteCollection.php:1270

/**
 * 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'].
 *
 * @param string      $search routeKey
 * @param string|null $verb   HTTP verb like `GET`,`POST` or `*` or `CLI`.
 *
 * @return list<string> filter_name or filter_name:arguments like 'role:admin,manager'
 */

Defined in .../Router/RouteCollection.php:1292

/**
 * Given a
 *
 * @throws RouterException
 *
 * @deprecated Unused. Now uses buildReverseRoute().
 */

Defined in .../Router/RouteCollection.php:1314

/**
 * Builds reverse route
 *
 * @param array $params One or more parameters to be passed to the route.
 *                      The last parameter allows you to set the locale.
 */

Defined in .../Router/RouteCollection.php:1351

/**
 * Replaces the {locale} tag with the locale
 */

Defined in .../Router/RouteCollection.php:1412

/**
 * 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.
 *
 * @param array|(Closure(mixed...): (ResponseInterface|string|void))|string $to
 *
 * @return void
 */

Defined in .../Router/RouteCollection.php:1442

/**
 * Compares the hostname passed in against the current hostname
 * on this page request.
 *
 * @param list<string>|string $hostname Hostname in route options
 */

Defined in .../Router/RouteCollection.php:1568

Defined in .../Router/RouteCollection.php:1585

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

Defined in .../Router/RouteCollection.php:1612

/**
 * Compares the subdomain(s) passed in against the current subdomain
 * on this page request.
 *
 * @param list<string>|string $subdomains
 */

Defined in .../Router/RouteCollection.php:1632

/**
 * 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.
 *
 * @return false|string the subdomain
 */

Defined in .../Router/RouteCollection.php:1665

/**
 * Reset the routes, so that a test case can provide the
 * explicit ones needed for it.
 *
 * @return void
 */

Defined in .../Router/RouteCollection.php:1706

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

Defined in .../Router/RouteCollection.php:1733

/**
 * Enable or Disable sorting routes by priority
 *
 * @param bool $enabled The value status
 *
 * @return $this
 */

Defined in .../Router/RouteCollection.php:1760

/**
 * Get all controllers in Route Handlers
 *
 * @param string|null $verb HTTP verb like `GET`,`POST` or `*` or `CLI`.
 *                          `'*'` returns all controllers in any verb.
 *
 * @return list<string> controller name list
 *
 * @interal
 */

Defined in .../Router/RouteCollection.php:1777

/**
 * @param (Closure(mixed...): (ResponseInterface|string|void))|string $handler Handler
 *
 * @return string|null Controller classname
 */

Defined in .../Router/RouteCollection.php:1823

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

Defined in .../Router/RouteCollection.php:1837

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

Defined in .../Router/RouteCollection.php:1847