Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Regex Route

__construct(
$route, $defaults
=
array(), $map
=
array(), $reverse
=
null
)
:
void
Name | Type | Description |
---|---|---|
$route | ||
$defaults | ||
$map | ||
$reverse |

_arrayMergeNumericKeys(
array $array1, array $array2
)
:
array
_arrayMergeNumericKeys() - allows for a strict key (numeric's included) array_merge.
php's array_merge() lacks the ability to merge with numeric keys.
Name | Type | Description |
---|---|---|
$array1 | array | |
$array2 | array |
Type | Description |
---|---|
array |

_getMappedValues(
array $values, boolean $reversed
=
false, boolean $preserve
=
false
)
:
array
Maps numerically indexed array values to it's associative mapped counterpart.
Or vice versa. Uses user provided map array which consists of index => name parameter mapping. If map is not found, it returns original array.
Method strips destination type of keys form source array. Ie. if source array is indexed numerically then every associative key will be stripped. Vice versa if reversed is set to true.
Name | Type | Description |
---|---|---|
$values | array | Indexed or associative array of values to map |
$reversed | boolean | False means translation of index to association. True means reverse. |
$preserve | boolean | Should wrong type of keys be preserved or stripped. |
Type | Description |
---|---|
array | An array of mapped values |

assemble(
array $data
=
array(), $reset
=
false, $encode
=
false, $partial
=
false
)
:
string
Assembles a URL path defined by this route
Name | Type | Description |
---|---|---|
$data | array | An array of name (or index) and value pairs used as parameters |
$reset | ||
$encode | ||
$partial |
Type | Description |
---|---|
string | Route path with user submitted parameters |

getDefault(
string $name
)
:
string
Return a single parameter of route's defaults
Name | Type | Description |
---|---|---|
$name | string | Array key of the parameter |
Type | Description |
---|---|
string | Previously set default |

getInstance(
\Zend_Config $config
)
:
void
Instantiates route based on passed Zend_Config structure
Name | Type | Description |
---|---|---|
$config | \Zend_Config | Configuration object |

match(
string $path, $partial
=
false
)
:
array|false
Matches a user submitted path with a previously defined route.
Assigns and returns an array of defaults on a successful match.
Name | Type | Description |
---|---|---|
$path | string | Path used to match against this routing map |
$partial |
Type | Description |
---|---|
array|false | An array of assigned values or a false on a mismatch |