Controller/Router/Interface.php
inherited
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Subpackage
- Router
- Version
- $Id: Interface.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Router_Interface
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
assemble(array $userParams, mixed $name = null, bool $reset = false, bool $encode = true) : stringGenerates 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.
| Name | Type | Description |
|---|---|---|
| $userParams | array | Options passed by a user used to override parameters |
| $name | mixed | The name of a Route to use |
| $reset | bool | Whether to reset to the route defaults ignoring URL params |
| $encode | bool | Tells to encode URL parts on output |
| Type | Description |
|---|---|
| string | Resulting URL path |
| Exception | Description |
|---|---|
| \Zend_Controller_Router_Exception |
clearParams(null | string | array $name = null) : \Zend_Controller_Router_InterfaceClear 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.
| Name | Type | Description |
|---|---|---|
| $name | null | string | array | single key or array of keys for params to clear |
| Type | Description |
|---|---|
| \Zend_Controller_Router_Interface |
getFrontController() : \Zend_Controller_FrontRetrieve Front Controller
| Type | Description |
|---|---|
| \Zend_Controller_Front |
getParam(string $name) : mixedRetrieve a single parameter from the controller parameter stack
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| mixed |
getParams() : arrayRetrieve the parameters to pass to helper object constructors
| Type | Description |
|---|---|
| array |
route( $dispatcher) : \Zend_Controller_Request_Abstract | booleanProcesses a request and sets its controller and action.
If no route was possible, an exception is thrown.
| Name | Type | Description |
|---|---|---|
| $dispatcher | Zend_Controller_Request_Abstract |
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract | boolean |
| Exception | Description |
|---|---|
| \Zend_Controller_Router_Exception |
setFrontController(\Zend_Controller_Front $controller) : \Zend_Controller_Router_InterfaceSet Front Controller
| Name | Type | Description |
|---|---|---|
| $controller | \Zend_Controller_Front |
| Type | Description |
|---|---|
| \Zend_Controller_Router_Interface |
setParam(string $name, $value) : \Zend_Controller_Router_InterfaceAdd or modify a parameter with which to instantiate any helper objects
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value |
| Type | Description |
|---|---|
| \Zend_Controller_Router_Interface |
setParams(array $params) : \Zend_Controller_Router_InterfaceSet an array of a parameters to pass to helper object constructors
| Name | Type | Description |
|---|---|---|
| $params | array |
| Type | Description |
|---|---|
| \Zend_Controller_Router_Interface |