class Route implements Router

The bidirectional route is responsible for mapping HTTP request to an array for dispatch and vice-versa.

Constants

VALUE

key used in metadata Route::__construct

PATTERN

key used in metadata Route::__construct

FILTER_IN

key used in metadata Route::__construct

FILTER_OUT

key used in metadata Route::__construct

FILTER_TABLE

key used in metadata Route::__construct

FILTER_STRICT

key used in metadata Route::__construct

private DEFAULT

key used in metadata

private FIXITY

key used in metadata

private FILTER_TABLE_OUT

key used in metadata

private HOST

url type

private PATH

url type

private RELATIVE

url type

private IN_QUERY

fixity types - has default value and is:

private IN_PATH

fixity types - has default value and is:

private CONSTANT

fixity types - has default value and is:

Properties

protected $defaultMeta

Methods

__construct(string $mask, array $metadata = [])

No description

string
getMask()

Returns mask.

array
getMetadata()

No description

array
getDefaults()

Returns default values.

array
getConstantParameters()

No description

array|null
match(IRequest $httpRequest)

Maps HTTP request to an array.

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

Constructs absolute URL from array.

static string
param2path(string $s)

Url encode.

Details

at line 84
__construct(string $mask, array $metadata = [])

No description

Parameters

string $mask

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

array $metadata

at line 95
string getMask()

Returns mask.

Return Value

string

at line 102
protected array getMetadata()

internal  
 

No description

Return Value

array

at line 111
array getDefaults()

Returns default values.

Return Value

array

at line 125
array getConstantParameters()

internal  
 

No description

Return Value

array

at line 141
array|null match(IRequest $httpRequest)

Maps HTTP request to an array.

Parameters

IRequest $httpRequest

Return Value

array|null

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

Constructs absolute URL from array.

Parameters

array $params
UrlScript $refUrl

Return Value

string|null

at line 624
static string param2path(string $s)

Url encode.

Parameters

string $s

Return Value

string

Traits

Strict class for better experience.