class RouteList implements Router

The router broker.

Properties

protected RouteList|null $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 $flags = 0)

Adds a router.

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

Prepends a router.

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

No description

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

No description

withDomain(string $domain)

Returns an iterator over all routers.

withPath(string $path)

No description

?static
end()

No description

array
getRouters()

No description

array
getFlags()

No description

string|null
getDomain()

No description

string|null
getPath()

No description

Details

at line 44
__construct()

No description

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

Maps HTTP request to an array.

Parameters

IRequest $httpRequest

Return Value

array|null

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

No description

Parameters

IRequest $httpRequest

Return Value

IRequest|null

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

No description

Parameters

array $params

Return Value

array|null

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

Constructs absolute URL from array.

Parameters

array $params
UrlScript $refUrl

Return Value

string|null

at line 145
void warmupCache()

No description

Return Value

void

at line 202
RouteList add(Router $router, int $flags = 0)

Adds a router.

Parameters

Router $router
int $flags

Return Value

RouteList

at line 213
void prepend(Router $router, int $flags = 0)

Prepends a router.

Parameters

Router $router
int $flags

Return Value

void

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

internal  
 

No description

Parameters

int $index
Router|null $router

Return Value

void

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

No description

Parameters

string $mask

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

array $metadata

default values or metadata

int $flags

Return Value

RouteList

at line 251
RouteList withDomain(string $domain)

Returns an iterator over all routers.

Parameters

string $domain

Return Value

RouteList

at line 265
RouteList withPath(string $path)

No description

Parameters

string $path

Return Value

RouteList

at line 279
?static end()

No description

Return Value

?static

at line 288
array getRouters()

No description

Return Value

array

at line 297
array getFlags()

No description

Return Value

array

at line 303
string|null getDomain()

No description

Return Value

string|null

at line 309
string|null getPath()

No description

Return Value

string|null

Traits

SmartObject