Controller/Action.php

Show:

inherited

Classes
- \Zend_Controller_Action

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Controller
Version: $Id$

\Zend_Controller_Action
jump to top

Package: Zend_Controller

Implements
Children: \Zend_Rest_Controller
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_classMethods

of existing class methods

Details

Type: array

array $_delimiters

Word delimiters (used for normalizing view script paths)

Details

Type: array

\Zend_Controller_Front $_frontController

Front controller instance

Details

Type: \Zend_Controller_Front

\Zend_Controller_Action_HelperBroker $_helper = null

Helper Broker to assist in routing help requests to the proper object

Default valuenullDetails

Type: \Zend_Controller_Action_HelperBroker

array $_invokeArgs = array()

Array of arguments provided to the constructor, minus the {@link $_request Request object}.

Default valuearray()Details

Type: array

\Zend_Controller_Request_Abstract $_request = null

Zend_Controller_Request_Abstract object wrapping the request environment

Default valuenullDetails

Type: \Zend_Controller_Request_Abstract

\Zend_Controller_Response_Abstract $_response = null

Zend_Controller_Response_Abstract object wrapping the response

Default valuenullDetails

Type: \Zend_Controller_Response_Abstract

\Zend_View_Interface $view

View object

Details

Type: \Zend_View_Interface

string $viewSuffix = 'phtml'

View script suffix; defaults to 'phtml'

Default value'phtml'Details

Type: string
See

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.

Parameters

Name	Type	Description
$methodName	string
$args	array

Throws

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 {@link getRequest()}, {@link getResponse()}, and {@link 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 {@link $_helper helper broker} is initialized. Finally, {@link init()} is called as the final action of instantiation, and may be safely overridden to perform initialization tasks; as a general rule, override {@link init()} instead of the constructor to customize an action controller's instantiation.

Parameters

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

final

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.

Parameters

Name	Type	Description
$action	string
$controller	string
$module	string
$params	array

Details

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.

Returns

Type	Description
array

Details

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.

Parameters

Name	Type	Description
$paramName	string
$default	mixed

Returns

Type	Description
mixed

_hasParam(string $paramName) : boolean

Determine whether a given parameter exists in the {@link $_request Request object}.

Parameters

Name	Type	Description
$paramName	string

Returns

Type	Description
boolean

Details

Deprecated: Deprecated as of Zend Framework 1.7. Use hasParam() instead.

_redirect(string $url, array $options = array()) : void

Redirect to another URL

Proxies to {@link Zend_Controller_Action_Helper_Redirector::gotoUrl()}.

Parameters

Name	Type	Description
$url	string
$options	array	Options to be used when redirecting

Details

Deprecated: Deprecated as of Zend Framework 1.7. Use redirect() instead.

_setInvokeArgs(array $args = array()) : \Zend_Controller_Action

Set invocation arguments

Parameters

Name	Type	Description
$args	array

Returns

Type	Description
\Zend_Controller_Action

_setParam(string $paramName, mixed $value) : \Zend_Controller_Action

Set a parameter in the {@link $_request Request object}.

Parameters

Name	Type	Description
$paramName	string
$value	mixed

Returns

Type	Description
\Zend_Controller_Action

Details

Deprecated: Deprecated as of Zend Framework 1.7. Use setParam() instead.

dispatch(string $action) : void

Dispatch the requested action

Parameters

Name	Type	Description
$action	string	Method name of action

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

final

Forward to another controller/action.

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.

Returns

Type	Description
array

getFrontController() : \Zend_Controller_Front

Retrieve Front Controller

Returns

Type	Description
\Zend_Controller_Front

getHelper(string $helperName) : \Zend_Controller_Action_Helper_Abstract

Get a helper by name

Parameters

Name	Type	Description
$helperName	string

Returns

Type	Description
\Zend_Controller_Action_Helper_Abstract

getHelperCopy(string $helperName) : \Zend_Controller_Action_Helper_Abstract

Get a clone of a helper by name

Parameters

Name	Type	Description
$helperName	string

Returns

Type	Description
\Zend_Controller_Action_Helper_Abstract

getInvokeArg(string $key) : mixed

Return a single invocation argument

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getInvokeArgs() : array

Return the array of constructor arguments (minus the Request object)

Returns

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.

Parameters

Name	Type	Description
$paramName	string
$default	mixed

Returns

Type	Description
mixed

getRequest() : \Zend_Controller_Request_Abstract

Return the Request object

Returns

Type	Description
\Zend_Controller_Request_Abstract

getResponse() : \Zend_Controller_Response_Abstract

Return the Response object

Returns

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.

Parameters

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

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Controller_Exception	with bad $action

hasParam(string $paramName) : boolean

Determine whether a given parameter exists in the {@link $_request Request object}.

Parameters

Name	Type	Description
$paramName	string

Returns

Type	Description
boolean

init() : void

Initialize object

Called from {@link __construct()} as final step of object instantiation.

initView() : \Zend_View_Interface

Initialize View object

Initializes {@link $view} if not otherwise a Zend_View_Interface. If {@link $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/

Returns

Type	Description
\Zend_View_Interface

Throws

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 {@link Zend_Controller_Front}, it may modify the {@link $_request 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 {@link Zend_Controller_Front}, it may modify the {@link $_request 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

Proxies to {@link Zend_Controller_Action_Helper_Redirector::gotoUrl()}.

Parameters

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 /.phtml. You may change the script suffix by resetting {@link $viewSuffix}. You may omit the controller directory prefix by specifying boolean true for $noController. By default, the rendered contents are appended to the response. You may specify the named body content segment to set by specifying a $name.

Parameters

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

Details

See

renderScript(string $script, string $name = null) : void

Render a given view script

Similar to {@link render()}, this method renders a view script. Unlike render(), however, it does not autodetermine the view script via {@link 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.

Parameters

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. {@link preDispatch()} is called prior to the action, {@link postDispatch()} is called following it.

Parameters

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

Returns

Type	Description
\Zend_Controller_Response_Abstract

setFrontController(\Zend_Controller_Front $front) : \Zend_Controller_Action

Set the front controller instance

Parameters

Name	Type	Description
$front	\Zend_Controller_Front

Returns

Type	Description
\Zend_Controller_Action

setParam(string $paramName, mixed $value) : \Zend_Controller_Action

Set a parameter in the {@link $_request Request object}.

Parameters

Name	Type	Description
$paramName	string
$value	mixed

Returns

Type	Description
\Zend_Controller_Action

setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Action

Set the Request object

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

Returns

Type	Description
\Zend_Controller_Action

setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Action

Set the Response object

Parameters

Name	Type	Description
$response	\Zend_Controller_Response_Abstract

Returns

Type	Description
\Zend_Controller_Action

Controller/Action.php

\Zend_Controller_Actionjump to top

Properties

Methods

\Zend_Controller_Action
jump to top