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

Pattern

key used in metadata

FilterIn

key used in metadata

FilterOut

key used in metadata

FilterTable

key used in metadata

FilterStrict

key used in metadata

VALUE

key used in metadata

PATTERN

key used in metadata

FILTER_IN

key used in metadata

FILTER_OUT

key used in metadata

FILTER_TABLE

key used in metadata

FILTER_STRICT

key used in metadata

private Default

key used in metadata

private Fixity

key used in metadata

private FilterTableOut

key used in metadata

private Host

url type

private Path

url type

private Relative

url type

private InQuery

fixity types - has default value and is:

private InPath

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 93
__construct(string $mask, array $metadata = [])

No description

Parameters

string $mask

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

array $metadata

at line 104
string getMask()

Returns mask.

Return Value

string

at line 111
protected array getMetadata()

internal  
 

No description

Return Value

array

at line 120
array getDefaults()

Returns default values.

Return Value

array

at line 134
array getConstantParameters()

internal  
 

No description

Return Value

array

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

Maps HTTP request to an array.

Parameters

IRequest $httpRequest

Return Value

array|null

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

Constructs absolute URL from array.

Parameters

array $params
UrlScript $refUrl

Return Value

string|null

at line 633
static string param2path(string $s)

Url encode.

Parameters

string $s

Return Value

string

Traits

SmartObject