Class Routes

The route collection.

Initial routes are collected from the "routes" config.

Event: ICanBoogie\Routes::collect:before

Third parties may use the event ICanBoogie\Routes\BeforeCollectEvent to alter the configuration fragments before they are synthesized. The event is fired during ICanBoogie\Routes::__construct().

Event: ICanBoogie\Routes::collect

Third parties may use the event ICanBoogie\Routes\CollectEvent to alter the routes read from the configuration. The event is fired during ICanBoogie\Routes::__construct().

ICanBoogie\Routes implements IteratorAggregate, ArrayAccess

Namespace: ICanBoogie
Located at vendor/icanboogie/routing/lib/routes.php

Methods summary

`public static ICanBoogie\Routes`	# `get( )` Returns the singleton instance of the class. Returns the singleton instance of the class. Returns `ICanBoogie\Routes`
`protected`	# `__construct( )` Collects routes definitions from the "routes" config. Collects routes definitions from the "routes" config.
`public`	# `__call( mixed $method, array $arguments )`
`public`	# `getIterator( )` Implementation of `IteratorAggregate::getIterator()`
`public`	# `offsetExists( mixed $offset )` Implementation of `ArrayAccess::offsetExists()`
`public`	# `offsetGet( mixed $id )` Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( mixed $id, array $route )` Adds or replaces a route. Adds or replaces a route. Parameters `$id` `mixed` $offset The identifier of the route. `$route` `array` $route The route definition. Throws `LogicException` if the route definition is invalid. See `ArrayAccess::offsetSet()` Implementation of `ArrayAccess::offsetSet()`
`public static`	# `add( mixed $id, mixed $definition )`
`public`	# `offsetUnset( string $offset )` Removes a route. Removes a route. Parameters `$offset` `string` $offset The identifier of the route. See `ArrayAccess::offsetUnset()` Implementation of `ArrayAccess::offsetUnset()`
`protected array`	# `collect( )` Returns route collection. Returns route collection. The collection is built in 4 steps: 1. Routes are traversed to add the `module` and `via` properties. If the route is defined by a module the `module` property is set to the id of the module, otherwise it is set to `null`. The `via` property is set to ICanBoogie\Request::METHOD_ANY if it is not defined. 2. The `ICanBoogie\Routes\BeforeCollectEvent` event is fired. Returns `array`
`public ICanBoogie\Route`	# `find( string $uri, array\|null & $captured = null, string $method = ICanBoogie\Request::METHOD_ANY, string $namespace = null )` Search for a route matching the specified pathname and method. Search for a route matching the specified pathname and method. Parameters `$uri` `string` $uri The URI to match. If the URI includes a query string it is removed before searching for a matching route. `$captured` `array\|null` $captured The parameters captured from the URI. If the URI included a query string, its parsed params are stored under the `__query__` key. `$method` `string` $method One of HTTP\Request::METHOD_* methods. `$namespace` `string` $namespace Namespace restriction. Returns `ICanBoogie\Route`

Magic methods summary

Properties summary

`protected static mixed`	`$instance`	#
`protected array`	`$routes`	#
`protected array`	`$instances`	#
`protected string`	`$default_route_class`	#

Namespaces

Classes

Interfaces

Traits

Exceptions

Constants

Functions

Class Routes

Event: ICanBoogie\Routes::collect:before

Event: ICanBoogie\Routes::collect

Methods summary

Returns

Implementation of

Implementation of

Implementation of

Parameters

Throws

See

Implementation of

Parameters

See

Implementation of

Returns

Parameters

Returns

Magic methods summary

Properties summary