Zend_Controller_ActionLocated in /Zend/Controller/Action.php (line 41)
void
__construct
(Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, [ $invokeArgs = array()])
Zend_Controller_Response_Abstract
run
([Zend_Controller_Request_Abstract $request = null], [Zend_Controller_Response_Abstract $response = null])
void
_forward
(string $action, [string $controller = null], [string $module = null], [ $params = null])
Zend_Controller_Front
$_frontController
(line 54)
Front controller instance
array
$_invokeArgs
= array() (line 48)
Array of arguments provided to the constructor, minus the $_request.
int
$_redirectCode
= 302 (line 60)
HTTP status code for redirects
bool
$_redirectExit
= true (line 66)
Whether or not calls to _redirect() should exit script execution
bool
$_redirectPrependBase
= true (line 73)
Whether or not _redirect() should attempt to prepend the base URL to the
passed URL (if it's a relative URL)
Zend_Controller_Request_Abstract
$_request
= null (line 79)
Zend_Controller_Request_Abstract object wrapping the request environment
Zend_Controller_Response_Abstract
$_response
= null (line 85)
Zend_Controller_Response_Abstract object wrapping the response
Constructor __construct (line 108)
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.
Additionally, 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.
dispatch (line 387)
Dispatch the requested action
getInvokeArg (line 199)
Return a single invocation argument
getInvokeArgs (line 188)
Return the array of constructor arguments (minus the Request object)
getRedirectCode (line 249)
Retrieve HTTP status code to emit on _redirect() call
getRedirectExit (line 288)
Retrieve flag for whether or not _redirect() will exit when finished.
getRedirectPrependBase (line 311)
Retrieve flag for whether or not _redirect() will prepend the base URL on relative URLs
init (line 123)
Initialize object
Called from __construct() as final step of object instantiation.
postDispatch (line 355)
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 (line 338)
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.
run (line 416)
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.
setRedirectCode (line 276)
Retrieve HTTP status code for _redirect() behaviour
setRedirectExit (line 299)
Retrieve exit flag for _redirect() behaviour
setRedirectPrependBase (line 322)
Retrieve 'prepend base' flag for _redirect() behaviour
_checkRedirectCode (line 260)
Validate HTTP status redirect code
_forward (line 525)
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.
_getAllParams (line 493)
Return all parameters in the $_request as an associative array.
_getParam (line 451)
Gets a parameter from the $_request. 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.
_hasParam (line 482)
Determine whether a given parameter exists in the $_request.
_redirect (line 571)
Redirect to another URL
By default, emits a 302 HTTP status header, prepends base URL as defined in request object if url is relative, and halts script execution by calling exit().
$options is an optional associative array that can be used to control redirect behaviour. The available option keys are:
If the exit flag is true (true by default), _redirect() will write and close the current session, if any.
_setInvokeArgs (line 177)
Set invocation arguments
_setParam (line 468)
Set a parameter in the $_request.
__call (line 368)
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.
Documentation generated on Wed, 21 Feb 2007 11:45:37 -0800 by phpDocumentor 1.3.1