Controller/Action/Helper/Url.php
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
- Zend_Controller_Action_Helper
- Version
- $Id: Url.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Action_Helper_Url
Helper for creating URLs for redirects and other tasks
- Parent(s)
- \Zend_Controller_Action_Helper_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Controller_Action_Helper_Abstract
Properties

\Zend_Controller_Action $_actionController = null$_actionController
Inherited from: \Zend_Controller_Action_Helper_Abstract::$$_actionControllernullDetails- Type
- \Zend_Controller_Action
- Inherited_from
- \Zend_Controller_Action_Helper_Abstract::$$_actionController

mixed $_frontController = nullnullDetails- Type
- mixed
- Inherited_from
- \Zend_Controller_Action_Helper_Abstract::$$_frontController
Methods

direct(string $action, string $controller = null, string $module = null, array $params = null) : stringPerform helper when called as $this->_helper->url() from an action controller
Proxies to simple()
| Name | Type | Description |
|---|---|---|
| $action | string | |
| $controller | string | |
| $module | string | |
| $params | array |
| Type | Description |
|---|---|
| string |

getActionController() : \Zend_Controller_ActionRetrieve current action controller
Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()| Type | Description |
|---|---|
| \Zend_Controller_Action |

getFrontController() : \Zend_Controller_FrontRetrieve front controller instance
Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()| Type | Description |
|---|---|
| \Zend_Controller_Front |

getRequest() : \Zend_Controller_Request_Abstract
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract | $request |

getResponse() : \Zend_Controller_Response_Abstract
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract | $response |

init() : voidHook into action controller initialization
Inherited from: \Zend_Controller_Action_Helper_Abstract::init()
postDispatch() : voidHook into action controller postDispatch() workflow
Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()
preDispatch() : voidHook into action controller preDispatch() workflow
Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()
setActionController(\Zend_Controller_Action $actionController = null) : \Zend_Controller_ActionHelper_AbstractsetActionController()
Inherited from: \Zend_Controller_Action_Helper_Abstract::setActionController()| Name | Type | Description |
|---|---|---|
| $actionController | \Zend_Controller_Action |
| Type | Description |
|---|---|
| \Zend_Controller_ActionHelper_Abstract | Provides a fluent interface |

simple(string $action, string $controller = null, string $module = null, array $params = null) : stringCreate URL based on default route
| Name | Type | Description |
|---|---|---|
| $action | string | |
| $controller | string | |
| $module | string | |
| $params | array |
| Type | Description |
|---|---|
| string |

url(array $urlOptions = array(), mixed $name = null, boolean $reset = false, boolean $encode = true) : stringAssembles a URL based on a given route
This method will typically be used for more complex operations, as it ties into the route objects registered with the router.
| Name | Type | Description |
|---|---|---|
| $urlOptions | array | Options passed to the assemble method of the Route object. |
| $name | mixed | The name of a Route to use. If null it will use the current Route |
| $reset | boolean | |
| $encode | boolean |
| Type | Description |
|---|---|
| string | Url for the link href attribute. |