Controller/Action/Helper/Url.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

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
jump to top

Package: Zend\Controller\Zend\Controller\Action\Helper
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

>VPropertyprotected\Zend_Controller_Action $_actionController = null
inherited
$_actionController
Inherited from: \Zend_Controller_Action_Helper_Abstract::$$_actionController
Default valuenullDetails
Type
\Zend_Controller_Action
Inherited_from
\Zend_Controller_Action_Helper_Abstract::$$_actionController  
>VPropertyprotectedmixed $_frontController = null
inherited
Inherited from: \Zend_Controller_Action_Helper_Abstract::$$_frontController
Default valuenullDetails
Type
mixed
Inherited_from
\Zend_Controller_Action_Helper_Abstract::$$_frontController  

Methods

methodpublicdirect(string $action, string $controller = null, string $module = null, array $params = null) : string

Perform helper when called as $this->_helper->url() from an action controller

Proxies to simple()

Parameters
NameTypeDescription
$actionstring
$controllerstring
$modulestring
$paramsarray
Returns
TypeDescription
string
methodpublicgetActionController() : \Zend_Controller_Action
inherited

Retrieve current action controller

Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()
Returns
TypeDescription
\Zend_Controller_Action
methodpublicgetFrontController() : \Zend_Controller_Front
inherited

Retrieve front controller instance

Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()
Returns
TypeDescription
\Zend_Controller_Front
methodpublicgetName() : string
inherited

getName()

Inherited from: \Zend_Controller_Action_Helper_Abstract::getName()
Returns
TypeDescription
string
methodpublicgetRequest() : \Zend_Controller_Request_Abstract
inherited

getRequest() -

Inherited from: \Zend_Controller_Action_Helper_Abstract::getRequest()
Returns
TypeDescription
\Zend_Controller_Request_Abstract$request
methodpublicgetResponse() : \Zend_Controller_Response_Abstract
inherited

getResponse() -

Inherited from: \Zend_Controller_Action_Helper_Abstract::getResponse()
Returns
TypeDescription
\Zend_Controller_Response_Abstract$response
methodpublicinit() : void
inherited

Hook into action controller initialization

Inherited from: \Zend_Controller_Action_Helper_Abstract::init()
methodpublicpostDispatch() : void
inherited

Hook into action controller postDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()
methodpublicpreDispatch() : void
inherited

Hook into action controller preDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()
methodpublicsetActionController(\Zend_Controller_Action $actionController = null) : \Zend_Controller_ActionHelper_Abstract
inherited

setActionController()

Inherited from: \Zend_Controller_Action_Helper_Abstract::setActionController()
Parameters
NameTypeDescription
$actionController\Zend_Controller_Action
Returns
TypeDescription
\Zend_Controller_ActionHelper_AbstractProvides a fluent interface
methodpublicsimple(string $action, string $controller = null, string $module = null, array $params = null) : string

Create URL based on default route

Parameters
NameTypeDescription
$actionstring
$controllerstring
$modulestring
$paramsarray
Returns
TypeDescription
string
methodpublicurl(array $urlOptions = array(), mixed $name = null, boolean $reset = false, boolean $encode = true) : string

Assembles 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.

Parameters
NameTypeDescription
$urlOptionsarray

Options passed to the assemble method of the Route object.

$namemixed

The name of a Route to use. If null it will use the current Route

$resetboolean
$encodeboolean
Returns
TypeDescription
stringUrl for the link href attribute.
Documentation was generated by phpDocumentor 2.0.0a12.