Class RouteCollection
A route collection.
- ICanBoogie\Routing\RouteCollection implements IteratorAggregate, ArrayAccess, Countable
Methods summary
public
__construct( array $definitions = [], boolean $trusted_definitions = false )
Parameters
$definitions$trusted_definitionsICanBoogie\Routing\RouteCollection::TRUSTED_DEFINITIONSif the definition can be trusted. This will speed up the construct process but the definitions will not be checked, nor will they be normalized.
public
__call( string $method, array $arguments )
: ICanBoogie\Routing\RouteCollection
Adds a route definition using an HTTP method.
Adds a route definition using an HTTP method.
Parameters
$method$arguments
Returns
protected
add( array $definition, boolean $trusted_definition = false )
: ICanBoogie\Routing\RouteCollection
Adds a route definition.
Adds a route definition.
Note: The method does not revoke cache.
Parameters
$definition$trusted_definitionICanBoogie\Routing\RouteCollection::TRUSTED_DEFINITIONSif the method should be trusting the definition, in which case the method doesn't assert if the definition is valid, nor does it normalizes it.
Returns
public
resource( string $name, string $controller, array $options = [] )
: array
Adds resource routes.
Adds resource routes.
Note: The route definitions for the resource are created by RouteMaker::resource. Both methods accept the same arguments.
Parameters
$name$controller$options
Returns
See
public
offsetGet( string $id )
: ICanBoogie\Routing\Route
Returns a ICanBoogie\Routing\Route instance.
Returns a ICanBoogie\Routing\Route instance.
Parameters
$id- Route identifier.
Returns
Throws
Implementation of
ArrayAccess::offsetGet()
public
offsetSet( string $id, array $route )
Defines a route.
Defines a route.
Parameters
$id- The identifier of the route.
$route- The route definition.
Implementation of
ArrayAccess::offsetSet()
public
offsetUnset( string $offset )
Removes a route.
Removes a route.
Parameters
$offset- The identifier of the route.
Implementation of
ArrayAccess::offsetUnset()
public
count( void )
: integer
Returns the number of routes in the collection.
Returns the number of routes in the collection.
Returns
Implementation of
Countable::count()
public
find( string $uri, array|null & $captured = null, string $method = Request::METHOD_ANY )
: ICanBoogie\Routing\Route|false|null
Search for a route matching the specified pathname and method.
Search for a route matching the specified pathname and method.
Parameters
$uriThe URI to match. If the URI includes a query string it is removed before searching for a matching route.
$capturedThe parameters captured from the URI. If the URI included a query string, its parsed params are stored under the
__query__key.$method- One of HTTP\Request::METHOD_* methods.
Returns
ICanBoogie\Routing\Route|false|null
public
filter( callable $filter )
: ICanBoogie\Routing\RouteCollection
Returns a new collection with filtered routes.
Returns a new collection with filtered routes.
Parameters
$filter
Returns
Magic methods summary
public
any( void )
: ICanBoogie\Routing\RouteCollection
any(string $pattern, $controller, array $options=[]) Add a route for any HTTP method.
any(string $pattern, $controller, array $options=[]) Add a route for any HTTP method.
Returns
public
connect( void )
: ICanBoogie\Routing\RouteCollection
connect(string $pattern, $controller, array $options=[]) Add a route for the HTTP method CONNECT.
connect(string $pattern, $controller, array $options=[]) Add a route for the HTTP method CONNECT.
Returns
public
delete( void )
: ICanBoogie\Routing\RouteCollection
delete(string $pattern, $controller, array $options=[]) Add a route for the HTTP method DELETE.
delete(string $pattern, $controller, array $options=[]) Add a route for the HTTP method DELETE.
Returns
public
get( void )
: ICanBoogie\Routing\RouteCollection
get(string $pattern, $controller, array $options=[]) Add a route for the HTTP method GET.
get(string $pattern, $controller, array $options=[]) Add a route for the HTTP method GET.
Returns
public
head( void )
: ICanBoogie\Routing\RouteCollection
head(string $pattern, $controller, array $options=[]) Add a route for the HTTP method HEAD.
head(string $pattern, $controller, array $options=[]) Add a route for the HTTP method HEAD.
Returns
public
options( void )
: ICanBoogie\Routing\RouteCollection
options(string $pattern, $controller, array $options=[]) Add a route for the HTTP method OPTIONS.
options(string $pattern, $controller, array $options=[]) Add a route for the HTTP method OPTIONS.
Returns
public
post( void )
: ICanBoogie\Routing\RouteCollection
post(string $pattern, $controller, array $options=[]) Add a route for the HTTP method POST.
post(string $pattern, $controller, array $options=[]) Add a route for the HTTP method POST.
Returns
public
put( void )
: ICanBoogie\Routing\RouteCollection
put(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PUT.
put(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PUT.
Returns
public
patch( void )
: ICanBoogie\Routing\RouteCollection
patch(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PATCH
patch(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PATCH
Returns
public
trace( void )
: ICanBoogie\Routing\RouteCollection
trace(string $pattern, $controller, array $options=[]) Add a route for the HTTP method TRACE.
trace(string $pattern, $controller, array $options=[]) Add a route for the HTTP method TRACE.
Returns
Constants summary
TRUSTED_DEFINITIONS
: boolean
Specify that the route definitions can be trusted.
Specify that the route definitions can be trusted.
true
DEFAULT_ROUTE_CLASS
: string
Class name of the ICanBoogie\Routing\Route instances.
Class name of the ICanBoogie\Routing\Route instances.
Route::class