class RouteList implements Router

The router broker.

Properties

protected $parent

Methods

__construct()

No description

array|null
match(IRequest $httpRequest)

Maps HTTP request to an array.

IRequest|null
prepareRequest(IRequest $httpRequest)

No description

array|null
completeParameters(array $params)

No description

string|null
constructUrl(array $params, UrlScript $refUrl)

Constructs absolute URL from array.

void
warmupCache()

No description

add(Router $router, int $oneWay = 0)

Adds a router.

void
prepend(Router $router, int $oneWay = 0)

Prepends a router.

void
modify(int $index, Router|null $router)

No description

addRoute(string $mask, array $metadata = [], int $oneWay = 0)

No description

withDomain(string $domain)

Returns an iterator over all routers.

withPath(string $path)

No description

RouteList|null
end()

No description

array
getRouters()

No description

array
getFlags()

No description

string|null
getDomain()

No description

string|null
getPath()

No description

Details

at line 33
__construct()

No description

at line 42
final array|null match(IRequest $httpRequest)

Maps HTTP request to an array.

Parameters

IRequest $httpRequest

Return Value

array|null

at line 58
protected IRequest|null prepareRequest(IRequest $httpRequest)

No description

Parameters

IRequest $httpRequest

Return Value

IRequest|null

at line 85
protected array|null completeParameters(array $params)

No description

Parameters

array $params

Return Value

array|null

at line 94
string|null constructUrl(array $params, UrlScript $refUrl)

Constructs absolute URL from array.

Parameters

array $params
UrlScript $refUrl

Return Value

string|null

at line 134
void warmupCache()

No description

Return Value

void

at line 190
RouteList add(Router $router, int $oneWay = 0)

Adds a router.

Parameters

Router $router
int $oneWay

Return Value

RouteList

at line 201
void prepend(Router $router, int $oneWay = 0)

Prepends a router.

Parameters

Router $router
int $oneWay

Return Value

void

at line 209
protected void modify(int $index, Router|null $router)

internal  
 

No description

Parameters

int $index
Router|null $router

Return Value

void

at line 228
RouteList addRoute(string $mask, array $metadata = [], int $oneWay = 0)

No description

Parameters

string $mask

e.g. '//<id \d{1,3}>'

array $metadata

default values or metadata

int $oneWay

Return Value

RouteList

at line 238
RouteList withDomain(string $domain)

Returns an iterator over all routers.

Parameters

string $domain

Return Value

RouteList

at line 249
RouteList withPath(string $path)

No description

Parameters

string $path

Return Value

RouteList

at line 260
RouteList|null end()

No description

Return Value

RouteList|null

at line 269
array getRouters()

No description

Return Value

array

at line 278
array getFlags()

No description

Return Value

array

at line 284
string|null getDomain()

No description

Return Value

string|null

at line 290
string|null getPath()

No description

Return Value

string|null