Class RouteCollection

A route collection.

ICanBoogie\Routing\RouteCollection implements IteratorAggregate, ArrayAccess, Countable

Namespace: ICanBoogie\Routing
Located at RouteCollection.php

Methods summary


				
				 public 
				
				

				__construct( array $definitions = [], boolean $trusted_definitions = false )

Parameters

$definitions
$trusted_definitions: ICanBoogie\Routing\RouteCollection::TRUSTED_DEFINITIONS if 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.


				
				 protected 
				
				

				add( array $definition, boolean $trusted_definition = false )
				

				: ICanBoogie\Routing\RouteCollection

Adds a route definition.

Note: The method does not revoke cache.

Parameters

$definition
$trusted_definition: ICanBoogie\Routing\RouteCollection::TRUSTED_DEFINITIONS if 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

ICanBoogie\Routing\RouteCollection
$this


				
				 public 
				
				

				resource( string $name, string $controller, array $options = [] )
				

				: array

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

array

See

\ICanBoogie\Routing\RoutesMaker::resource


				
				 public 
				
				

				getIterator( void )


				
				 public 
				
				

				offsetExists(  $offset )


				
				 public 
				
				

				offsetGet( string $id )
				

				: ICanBoogie\Routing\Route

Returns a ICanBoogie\Routing\Route instance.


				
				 public 
				
				

				offsetSet( string $id, array $route )

Defines a route.


				
				 public 
				
				

				offsetUnset( string $offset )

Removes a route.


				
				 public 
				
				

				count( void )
				

				: integer

Returns the number of routes in the collection.


				
				 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.

Parameters

$uri: The URI to match. If the URI includes a query string it is removed before searching for a matching route.
$captured: The 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.

Magic methods summary


				
				 public 
				
				

				any( void )
				

				: ICanBoogie\Routing\RouteCollection

any(string $pattern, $controller, array $options=[]) Add a route for any HTTP method.


				
				 public 
				
				

				connect( void )
				

				: ICanBoogie\Routing\RouteCollection

connect(string $pattern, $controller, array $options=[]) Add a route for the HTTP method CONNECT.


				
				 public 
				
				

				delete( void )
				

				: ICanBoogie\Routing\RouteCollection

delete(string $pattern, $controller, array $options=[]) Add a route for the HTTP method DELETE.


				
				 public 
				
				

				get( void )
				

				: ICanBoogie\Routing\RouteCollection

get(string $pattern, $controller, array $options=[]) Add a route for the HTTP method GET.


				
				 public 
				
				

				head( void )
				

				: ICanBoogie\Routing\RouteCollection

head(string $pattern, $controller, array $options=[]) Add a route for the HTTP method HEAD.


				
				 public 
				
				

				options( void )
				

				: ICanBoogie\Routing\RouteCollection

options(string $pattern, $controller, array $options=[]) Add a route for the HTTP method OPTIONS.


				
				 public 
				
				

				post( void )
				

				: ICanBoogie\Routing\RouteCollection

post(string $pattern, $controller, array $options=[]) Add a route for the HTTP method POST.


				
				 public 
				
				

				put( void )
				

				: ICanBoogie\Routing\RouteCollection

put(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PUT.


				
				 public 
				
				

				patch( void )
				

				: ICanBoogie\Routing\RouteCollection

patch(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PATCH


				
				 public 
				
				

				trace( void )
				

				: ICanBoogie\Routing\RouteCollection

trace(string $pattern, $controller, array $options=[]) Add a route for the HTTP method TRACE.

Constants summary


				
TRUSTED_DEFINITIONS				

                : boolean

Specify that the route definitions can be trusted.

true


				
DEFAULT_ROUTE_CLASS				

                : string

Class name of the ICanBoogie\Routing\Route instances.

Route::class

Properties summary


				
				protected  
				

				
$routes				

				: array

Route definitions.

[]


				
				protected  
				

				
$instances				

				: ICanBoogie\Routing\Route[]

Route instances.

[]

Class RouteCollection

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Implementation of

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Magic methods summary

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Constants summary

Properties summary