Class Route (namespace Nette\Application)

The bidirectional route is responsible for mapping HTTP request to a PresenterRoute object for dispatch and vice-versa.

Object
   |
   --Route

Implements interfaces:

IRouter

Public Method Summary
static void	addStyle (string `$style`, [string `$parent` = `'#'`], void `2`) Creates new style.
string\|NULL	constructUrl (PresenterRequest `$appRequest`, `$httpRequest`) Constructs absolute URL from PresenterRequest object.
Route	__construct (string `$mask`, [`$defaults` = `array()`], [int `$flags` = `0`])
array	getDefaults () Returns default values.
string	getMask () Returns mask.
string\|FALSE	getTargetPresenter () Proprietary cache aim.
PresenterRequest\|NULL	match (`$httpRequest`) Maps HTTP request to a PresenterRequest object.
static void	setStyleProperty (string `$style`, string `$key`, mixed `$value`, void `3`) Changes style property value.

Methods Inherited From Object
extensionMethod(), getClass(), getReflection(), __call(), __callStatic(), __get(), __isset(), __set(), __unset()

Constant Summary
int	`CASE_SENSITIVE`	`256`	line 43 flag
string	`FILTER_IN`	`'filterIn'`	line 53 key used in Route::$styles
string	`FILTER_OUT`	`'filterOut'`	line 54 key used in Route::$styles
string	`FILTER_TABLE`	`'filterTable'`	line 55 key used in Route::$styles
int	`HOST`	`1`	line 46 uri type
string	`MODULE_KEY`	`'module'`	line 40
int	`PATH`	`2`	line 47 uri type
string	`PATTERN`	`'pattern'`	line 52 key used in Route::$styles
string	`PRESENTER_KEY`	`'presenter'`	line 39
int	`RELATIVE`	`3`	line 48 uri type

Variable Summary
static bool	`$defaultFlags`	`0`	line 65
protected int	`$flags`		line 118
protected array	`$metadata`	`array()`	line 109 of [default & fixity, filterIn, filterOut]
static array	`$styles`	`array( '#' => array( // default style for path parameters self::PATTERN => '[^/]+',...`	line 68
protected int	`$type`		line 115 HOST, PATH, RELATIVE
protected array	`$xlat`		line 112

Method Details

line 700

addStyle

public static void addStyle (string $style, [string $parent = '#'], void 2)

Creates new style.

Input
string	`$style`	style name (#style, urlParameter, ?queryParameter)
string	`$parent`	optional parent style name
void	`2`
Output
void

line 249

constructUrl

public string|NULL constructUrl (PresenterRequest $appRequest, $httpRequest)

Constructs absolute URL from PresenterRequest object.

Implementation of:

IRouter::constructUrl()

Input
PresenterRequest	`$appRequest`
	`$httpRequest`
Output
string\|NULL

line 127

__construct

public Route __construct (string $mask, [$defaults = array()], [int $flags = 0])

Input
string	`$mask`	URL mask, e.g. '<presenter>/<action>/<id \d{1,3}>'
	`$defaults`	default values
int	`$flags`	flags
Output
Route

line 550

getDefaults

public array getDefaults ()

Returns default values.

Output
array

line 539

getMask

public string getMask ()

Returns mask.

Output
string

line 571

getTargetPresenter

public string|FALSE getTargetPresenter ()

Proprietary cache aim.

Output
string\|FALSE

line 140

match

public PresenterRequest|NULL match ($httpRequest)

Maps HTTP request to a PresenterRequest object.

Implementation of:

IRouter::match()

Input
	`$httpRequest`
Output
PresenterRequest\|NULL

line 726

setStyleProperty

public static void setStyleProperty (string $style, string $key, mixed $value, void 3)

Changes style property value.

Input
string	`$style`	style name (#style, urlParameter, ?queryParameter)
string	`$key`	property name (Route::PATTERN, Route::FILTER_IN, Route::FILTER_OUT, Route::FILTER_TABLE)
mixed	`$value`	property value
void	`3`
Output
void