Controller/Action.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
- Version
- $Id: Action.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Action
- Implements
- \Zend_Controller_Action_Interface
- Children
- \Zend_Rest_Controller
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


\Zend_Controller_Action_HelperBroker $_helper = null
Helper Broker to assist in routing help requests to the proper object
null
Details


array $_invokeArgs = array()
Array of arguments provided to the constructor, minus the {@link $_request Request object}.
array()
Details- Type
- array


\Zend_Controller_Request_Abstract $_request = null
Zend_Controller_Request_Abstract object wrapping the request environment
null
Details


\Zend_Controller_Response_Abstract $_response = null
Zend_Controller_Response_Abstract object wrapping the response
null
Details
Methods


__call(string $methodName, array $args) : void
Proxy for undefined methods.
Default behavior is to throw an exception on undefined methods, however this function can be overridden to implement magic (dynamic) actions, or provide run-time dispatching.
Name | Type | Description |
---|---|---|
$methodName | string | |
$args | array |
Exception | Description |
---|---|
\Zend_Controller_Action_Exception |


__construct(\Zend_Controller_Request_Abstract $request, \Zend_Controller_Response_Abstract $response, array $invokeArgs = array()) : void
Class constructor
The request and response objects should be registered with the controller, as should be any additional optional arguments; these will be available via getRequest(), getResponse(), and getInvokeArgs(), respectively.
When overriding the constructor, please consider this usage as a best practice and ensure that each is registered appropriately; the easiest way to do so is to simply call parent::__construct($request, $response, $invokeArgs).
After the request, response, and invokeArgs are set, the helper broker is initialized.
Finally, init() is called as the final action of instantiation, and may be safely overridden to perform initialization tasks; as a general rule, override init() instead of the constructor to customize an action controller's instantiation.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract | |
$response | \Zend_Controller_Response_Abstract | |
$invokeArgs | array | Any additional invocation arguments |


_forward(string $action, string $controller = null, string $module = null, array $params = null) : void
Forward to another controller/action.
It is important to supply the unformatted names, i.e. "article" rather than "ArticleController". The dispatcher will do the appropriate formatting when the request is received.
If only an action name is provided, forwards to that action in this controller.
If an action and controller are specified, forwards to that action and controller in this module.
Specifying an action, controller, and module is the most specific way to forward.
A fourth argument, $params, will be used to set the request parameters. If either the controller or module are unnecessary for forwarding, simply pass null values for them before specifying the parameters.
Name | Type | Description |
---|---|---|
$action | string | |
$controller | string | |
$module | string | |
$params | array |
- Deprecated
- Deprecated as of Zend Framework 1.7. Use forward() instead.


_getAllParams() : array
Return all parameters in the {@link $_request Request object} as an associative array.
Type | Description |
---|---|
array |
- Deprecated
- Deprecated as of Zend Framework 1.7. Use getAllParams() instead.


_getParam(string $paramName, mixed $default = null) : mixed
Gets a parameter from the {@link $_request Request object}.
If the parameter does not exist, NULL will be returned.
If the parameter does not exist and $default is set, then $default will be returned instead of NULL.
Name | Type | Description |
---|---|---|
$paramName | string | |
$default | mixed |
Type | Description |
---|---|
mixed |


_hasParam(string $paramName) : boolean
Determine whether a given parameter exists in the {@link $_request Request object}.
Name | Type | Description |
---|---|---|
$paramName | string |
Type | Description |
---|---|
boolean |
- Deprecated
- Deprecated as of Zend Framework 1.7. Use hasParam() instead.


_redirect(string $url, array $options = array()) : void
Redirect to another URL
Name | Type | Description |
---|---|---|
$url | string | |
$options | array | Options to be used when redirecting |
- Deprecated
- Deprecated as of Zend Framework 1.7. Use redirect() instead.


_setInvokeArgs(array $args = array()) : \Zend_Controller_Action
Set invocation arguments
Name | Type | Description |
---|---|---|
$args | array |
Type | Description |
---|---|
\Zend_Controller_Action |


_setParam(string $paramName, mixed $value) : \Zend_Controller_Action
Set a parameter in the {@link $_request Request object}.
Name | Type | Description |
---|---|---|
$paramName | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Controller_Action |
- Deprecated
- Deprecated as of Zend Framework 1.7. Use setParam() instead.


dispatch(string $action) : void
Dispatch the requested action
Name | Type | Description |
---|---|---|
$action | string | Method name of action |


forward(string $action, string $controller = null, string $module = null, array $params = null) : void
Forward to another controller/action.
It is important to supply the unformatted names, i.e. "article" rather than "ArticleController". The dispatcher will do the appropriate formatting when the request is received.
If only an action name is provided, forwards to that action in this controller.
If an action and controller are specified, forwards to that action and controller in this module.
Specifying an action, controller, and module is the most specific way to forward.
A fourth argument, $params, will be used to set the request parameters. If either the controller or module are unnecessary for forwarding, simply pass null values for them before specifying the parameters.
Name | Type | Description |
---|---|---|
$action | string | |
$controller | string | |
$module | string | |
$params | array |


getAllParams() : array
Return all parameters in the {@link $_request Request object} as an associative array.
Type | Description |
---|---|
array |


getFrontController() : \Zend_Controller_Front
Retrieve Front Controller
Type | Description |
---|---|
\Zend_Controller_Front |


getHelper(string $helperName) : \Zend_Controller_Action_Helper_Abstract
Get a helper by name
Name | Type | Description |
---|---|---|
$helperName | string |
Type | Description |
---|---|
\Zend_Controller_Action_Helper_Abstract |


getHelperCopy(string $helperName) : \Zend_Controller_Action_Helper_Abstract
Get a clone of a helper by name
Name | Type | Description |
---|---|---|
$helperName | string |
Type | Description |
---|---|
\Zend_Controller_Action_Helper_Abstract |


getInvokeArg(string $key) : mixed
Return a single invocation argument
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |


getInvokeArgs() : array
Return the array of constructor arguments (minus the Request object)
Type | Description |
---|---|
array |


getParam(string $paramName, mixed $default = null) : mixed
Gets a parameter from the {@link $_request Request object}.
If the parameter does not exist, NULL will be returned.
If the parameter does not exist and $default is set, then $default will be returned instead of NULL.
Name | Type | Description |
---|---|---|
$paramName | string | |
$default | mixed |
Type | Description |
---|---|
mixed |


getRequest() : \Zend_Controller_Request_Abstract
Return the Request object
Type | Description |
---|---|
\Zend_Controller_Request_Abstract |


getResponse() : \Zend_Controller_Response_Abstract
Return the Response object
Type | Description |
---|---|
\Zend_Controller_Response_Abstract |


getViewScript(string $action = null, bool $noController = null) : string
Construct view script path
Used by render() to determine the path to the view script.
Name | Type | Description |
---|---|---|
$action | string | Defaults to action registered in request object |
$noController | bool | Defaults to false; i.e. use controller name as subdir in which to search for view script |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Controller_Exception | with bad $action |


hasParam(string $paramName) : boolean
Determine whether a given parameter exists in the {@link $_request Request object}.
Name | Type | Description |
---|---|---|
$paramName | string |
Type | Description |
---|---|
boolean |


initView() : \Zend_View_Interface
Initialize View object
Initializes $view if not otherwise a Zend_View_Interface.
If $view is not otherwise set, instantiates a new Zend_View object, using the 'views' subdirectory at the same level as the controller directory for the current module as the base directory. It uses this to set the following: - script path = views/scripts/ - helper path = views/helpers/ - filter path = views/filters/
Type | Description |
---|---|
\Zend_View_Interface |
Exception | Description |
---|---|
\Zend_Controller_Exception | if base view directory does not exist |


postDispatch() : void
Post-dispatch routines
Called after action method execution. If using class with Zend_Controller_Front, it may modify the Request object and reset its dispatched flag in order to process an additional action.
Common usages for postDispatch() include rendering content in a sitewide template, link url correction, setting headers, etc.


preDispatch() : void
Pre-dispatch routines
Called before action method. If using class with Zend_Controller_Front, it may modify the Request object and reset its dispatched flag in order to skip processing the current action.


redirect(string $url, array $options = array()) : void
Redirect to another URL
Name | Type | Description |
---|---|---|
$url | string | |
$options | array | Options to be used when redirecting |


render(string | null $action = null, string | null $name = null, bool $noController = false) : void
Render a view
Renders a view. By default, views are found in the view script path as
By default, the rendered contents are appended to the response. You may specify the named body content segment to set by specifying a $name.
Name | Type | Description |
---|---|---|
$action | string | null | Defaults to action registered in request object |
$name | string | null | Response object named path segment to use; defaults to null |
$noController | bool | Defaults to false; i.e. use controller name as subdir in which to search for view script |
- See
- \global\Zend_Controller_Response_Abstract::appendBody()


renderScript(string $script, string $name = null) : void
Render a given view script
Similar to render(), this method renders a view script. Unlike render(), however, it does not autodetermine the view script via getViewScript(), but instead renders the script passed to it. Use this if you know the exact view script name and path you wish to use, or if using paths that do not conform to the spec defined with getViewScript().
By default, the rendered contents are appended to the response. You may specify the named body content segment to set by specifying a $name.
Name | Type | Description |
---|---|---|
$script | string | |
$name | string |


run(null | \Zend_Controller_Request_Abstract $request = null, null | \Zend_Controller_Response_Abstract $response = null) : \Zend_Controller_Response_Abstract
Call the action specified in the request object, and return a response
Not used in the Action Controller implementation, but left for usage in Page Controller implementations. Dispatches a method based on the request.
Returns a Zend_Controller_Response_Abstract object, instantiating one prior to execution if none exists in the controller.
preDispatch() is called prior to the action, postDispatch() is called following it.
Name | Type | Description |
---|---|---|
$request | null | \Zend_Controller_Request_Abstract | Optional request object to use |
$response | null | \Zend_Controller_Response_Abstract | Optional response object to use |
Type | Description |
---|---|
\Zend_Controller_Response_Abstract |


setFrontController(\Zend_Controller_Front $front) : \Zend_Controller_Action
Set the front controller instance
Name | Type | Description |
---|---|---|
$front | \Zend_Controller_Front |
Type | Description |
---|---|
\Zend_Controller_Action |


setParam(string $paramName, mixed $value) : \Zend_Controller_Action
Set a parameter in the {@link $_request Request object}.
Name | Type | Description |
---|---|---|
$paramName | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Controller_Action |


setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Action
Set the Request object
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
\Zend_Controller_Action |


setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Action
Set the Response object
Name | Type | Description |
---|---|---|
$response | \Zend_Controller_Response_Abstract |
Type | Description |
---|---|
\Zend_Controller_Action |