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:

Copyright: Copyright (c) 2004, 2010 David Grudl
Located: in /Application/Routers/Route.php (line 22)
Public Method Summary
Route
__construct (string $mask, [$metadata = array()], [int $flags = 0])
static void
addStyle (string $style, [string $parent = '#'], void 2)
Creates new style.
string|NULL
constructUrl (PresenterRequest $appRequest, $httpRequest)
Constructs absolute URL from PresenterRequest object.
array
Returns default values.
string
getMask ()
Returns mask.
string|FALSE
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 28

flag
string FILTER_IN 'filterIn'

line 40

key used in Route::$styles or metadata Route::__construct
string FILTER_OUT 'filterOut'

line 41

key used in Route::$styles or metadata Route::__construct
string FILTER_TABLE 'filterTable'

line 42

key used in Route::$styles or metadata Route::__construct
int FULL_META 128

line 29

string MODULE_KEY 'module'

line 25

string PATTERN 'pattern'

line 39

key used in Route::$styles or metadata Route::__construct
string PRESENTER_KEY 'presenter'

line 24

string VALUE 'value'

line 38

key used in Route::$styles or metadata Route::__construct
Variable Summary
static bool $defaultFlags 0

line 52

static array $styles array( '#' => array( // default style for path parameters self::PATTERN => '[^/]+',...

line 55


Method Details

line 114

__construct

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

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

line 726

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 245

constructUrl

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

Constructs absolute URL from PresenterRequest object.

Implementation of:

Input
PresenterRequest $appRequest
$httpRequest
Output
string|NULL  

line 576

getDefaults

public array getDefaults ()

Returns default values.

Output
array  

line 565

getMask

public string getMask ()

Returns mask.

Output
string  

line 597

getTargetPresenter

public string|FALSE getTargetPresenter ()

Proprietary cache aim.

Output
string|FALSE  

line 132

match

public PresenterRequest|NULL match ($httpRequest)

Maps HTTP request to a PresenterRequest object.

Implementation of:

Input
$httpRequest
Output
PresenterRequest|NULL  

line 752

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