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.
Module Route
Default route for module functionality

array
$_defaults= ''
Default values for the route (ie. module, controller, action, params)

__construct(
array $defaults
=
array(), \Zend_Controller_Dispatcher_Interface $dispatcher
=
null, \Zend_Controller_Request_Abstract $request
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$defaults | array | Defaults for map variables with keys as variable names |
$dispatcher | \Zend_Controller_Dispatcher_Interface | Dispatcher object |
$request | \Zend_Controller_Request_Abstract | Request object |

assemble(
array $data
=
array(), bool $reset
=
false, $encode
=
true, $partial
=
false
)
:
string
Assembles user submitted parameters forming a URL path defined by this route
Name | Type | Description |
---|---|---|
$data | array | An array of variable and value pairs used as parameters |
$reset | bool | Weither to reset the current params |
$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(
$config
)
:
void
Instantiates route based on passed Zend_Config structure
Name | Type | Description |
---|---|---|
$config |

match(
string $path, $partial
=
false
)
:
array
Matches a user submitted path. Assigns and returns an array of variables on a successful match.
If a request object is registered, it uses its setModuleName(), setControllerName(), and setActionName() accessors to set those values. Always returns the values as an array.
Name | Type | Description |
---|---|---|
$path | string | Path used to match against this routing map |
$partial |
Type | Description |
---|---|
array | An array of assigned values or a false on a mismatch |