Zend Framework
1.12
|
Public Member Functions | |
route (Zend_Controller_Request_Abstract $dispatcher) | |
Processes a request and sets its controller and action. | |
assemble ($userParams, $name=null, $reset=false, $encode=true) | |
Generates a URL path that can be used in URL creation, redirection, etc. | |
getFrontController () | |
Retrieve Front Controller. | |
setFrontController (Zend_Controller_Front $controller) | |
Set Front Controller. | |
setParam ($name, $value) | |
Add or modify a parameter with which to instantiate any helper objects. | |
setParams (array $params) | |
Set an array of a parameters to pass to helper object constructors. | |
getParam ($name) | |
Retrieve a single parameter from the controller parameter stack. | |
getParams () | |
Retrieve the parameters to pass to helper object constructors. | |
clearParams ($name=null) | |
Clear the controller parameter stack. | |
assemble | ( | $userParams, | |
$name = null , |
|||
$reset = false , |
|||
$encode = true |
|||
) |
Generates a URL path that can be used in URL creation, redirection, etc.
May be passed user params to override ones from URI, Request or even defaults. If passed parameter has a value of null, it's URL variable will be reset to default.
If null is passed as a route name assemble will use the current Route or 'default' if current is not yet set.
Reset is used to signal that all parameters should be reset to it's defaults. Ignoring all URL specified values. User specified params still get precedence.
Encode tells to url encode resulting path parts.
array | $userParams | Options passed by a user used to override parameters |
mixed | $name | The name of a Route to use |
bool | $reset | Whether to reset to the route defaults ignoring URL params |
bool | $encode | Tells to encode URL parts on output |
Zend_Controller_Router_Exception |
Implemented in Zend_Controller_Router_Rewrite.
clearParams | ( | $name = null | ) |
Clear the controller parameter stack.
By default, clears all parameters. If a parameter name is given, clears only that parameter; if an array of parameter names is provided, clears each.
null|string|array | single key or array of keys for params to clear |
Implemented in Zend_Controller_Router_Abstract.
getFrontController | ( | ) |
Retrieve Front Controller.
Implemented in Zend_Controller_Router_Abstract.
getParam | ( | $name | ) |
Retrieve a single parameter from the controller parameter stack.
string | $name |
Implemented in Zend_Controller_Router_Abstract.
getParams | ( | ) |
Retrieve the parameters to pass to helper object constructors.
Implemented in Zend_Controller_Router_Abstract.
route | ( | Zend_Controller_Request_Abstract | $dispatcher | ) |
Processes a request and sets its controller and action.
If no route was possible, an exception is thrown.
Zend_Controller_Request_Abstract |
Zend_Controller_Router_Exception |
Implemented in Zend_Controller_Router_Rewrite.
setFrontController | ( | Zend_Controller_Front | $controller | ) |
Set Front Controller.
Zend_Controller_Front | $controller |
Implemented in Zend_Controller_Router_Abstract.
setParam | ( | $name, | |
$value | |||
) |
Add or modify a parameter with which to instantiate any helper objects.
string | $name | |
mixed | $param |
Implemented in Zend_Controller_Router_Abstract.
setParams | ( | array | $params | ) |
Set an array of a parameters to pass to helper object constructors.
array | $params |
Implemented in Zend_Controller_Router_Abstract.