Abstract Class Zend_Controller_Action

Description
  • abstract:
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Controller/Action.php (line 41)


	
			
Variable Summary
Method Summary
 void __construct (Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, [ $invokeArgs = array()])
 void dispatch (string $action)
 mixed getInvokeArg (string $key)
 array getInvokeArgs ()
 bool getRedirectExit ()
 string getViewScript ([string $action = null], [bool $noController = false])
 void init ()
 void postDispatch ()
 void preDispatch ()
 void render ([string|null $action = null], [string|null $name = null], [bool $noController = false])
 true _checkRedirectCode (int $code)
 void _forward (string $action, [string $controller = null], [string $module = null], [ $params = null])
 array _getAllParams ()
 mixed _getParam (string $paramName, [mixed $default = null])
 boolean _hasParam (string $paramName)
 void _redirect (string $url, [ $options = null])
 Zend_Controller_Action _setInvokeArgs ([ $args = array()])
 Zend_Controller_Action _setParam (string $paramName, mixed $value)
 void __call (string $methodName, array $args)
Variables
Zend_View_Interface $view (line 98)

View object

  • access: public
string $viewSuffix = 'phtml' (line 92)

View script suffix; defaults to 'phtml'

  • access: public
  • see: {render()}
Zend_Controller_Front $_frontController (line 54)

Front controller instance

  • access: protected
array $_invokeArgs = array() (line 48)

Array of arguments provided to the constructor, minus the $_request.

  • access: protected
int $_redirectCode = 302 (line 60)

HTTP status code for redirects

  • access: protected
bool $_redirectExit = true (line 66)

Whether or not calls to _redirect() should exit script execution

  • access: protected
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)

  • access: protected
Zend_Controller_Request_Abstract $_request = null (line 79)

Zend_Controller_Request_Abstract object wrapping the request environment

  • access: protected
Zend_Controller_Response_Abstract $_response = null (line 85)

Zend_Controller_Response_Abstract object wrapping the response

  • access: protected
Methods
Constructor __construct (line 121)

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.

  • access: public
void __construct (Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, [ $invokeArgs = array()])
dispatch (line 496)

Dispatch the requested action

  • access: public
void dispatch (string $action)
  • string $action: Method name of action
getFrontController (line 334)

Retrieve Front Controller

  • access: public
Zend_Controller_Front getFrontController ()
getInvokeArg (line 308)

Return a single invocation argument

  • access: public
mixed getInvokeArg (string $key)
  • string $key
getInvokeArgs (line 297)

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

  • access: public
array getInvokeArgs ()
getRedirectCode (line 358)

Retrieve HTTP status code to emit on _redirect() call

  • access: public
int getRedirectCode ()
getRedirectExit (line 397)

Retrieve flag for whether or not _redirect() will exit when finished.

  • access: public
bool getRedirectExit ()
getRedirectPrependBase (line 420)

Retrieve flag for whether or not _redirect() will prepend the base URL on relative URLs

  • access: public
bool getRedirectPrependBase ()
getRequest (line 241)

Return the Request object

  • access: public
getResponse (line 263)

Return the Response object

  • access: public
getViewScript (line 218)

Construct view script path

Used by render() to determine the path to the view script.

  • access: public
  • throws: Zend_Controller_Exception with bad $action
string getViewScript ([string $action = null], [bool $noController = false])
  • string $action: Defaults to action registered in request object
  • bool $noController: Defaults to false; i.e. use controller name as subdir in which to search for view script
init (line 136)

Initialize object

Called from __construct() as final step of object instantiation.

  • access: public
void init ()
initView (line 156)

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/

  • access: public
  • throws: Zend_Controller_Exception if base view directory does not exist
Zend_View_Interface initView ()
postDispatch (line 464)

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.

  • access: public
void postDispatch ()
preDispatch (line 447)

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.

  • access: public
void preDispatch ()
render (line 197)

Render a view

Renders a view. By default, views are found in the view script path as <controller>/<action>.phtml. You may change the script suffix by resetting $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.

void render ([string|null $action = null], [string|null $name = null], [bool $noController = false])
  • string|null $action: Defaults to action registered in request object
  • string|null $name: Response object named path segment to use; defaults to null
  • bool $noController: Defaults to false; i.e. use controller name as subdir in which to search for view script
run (line 525)

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.

  • access: public
setFrontController (line 323)

Set the front controller instance

  • access: public
Zend_Controller_Action setFrontController (Zend_Controller_Front $front)
setRedirectCode (line 385)

Retrieve HTTP status code for _redirect() behaviour

  • access: public
Zend_Controller_Action setRedirectCode (int $code)
  • int $code
setRedirectExit (line 408)

Retrieve exit flag for _redirect() behaviour

  • access: public
Zend_Controller_Action setRedirectExit (bool $flag)
  • bool $flag
setRedirectPrependBase (line 431)

Retrieve 'prepend base' flag for _redirect() behaviour

  • access: public
Zend_Controller_Action setRedirectPrependBase (bool $flag)
  • bool $flag
setRequest (line 252)

Set the Request object

  • access: public
setResponse (line 274)

Set the Response object

  • access: public
_checkRedirectCode (line 369)

Validate HTTP status redirect code

  • access: protected
true _checkRedirectCode (int $code)
  • int $code
_forward (line 634)

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.

  • access: protected
void _forward (string $action, [string $controller = null], [string $module = null], [ $params = null])
  • string $action
  • string $controller
  • string $module
  • array $params
_getAllParams (line 602)

Return all parameters in the $_request as an associative array.

  • access: protected
array _getAllParams ()
_getParam (line 560)

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.

  • access: protected
mixed _getParam (string $paramName, [mixed $default = null])
  • string $paramName
  • mixed $default
_hasParam (line 591)

Determine whether a given parameter exists in the $_request.

  • access: protected
boolean _hasParam (string $paramName)
  • string $paramName
_redirect (line 680)

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:

  • exit: boolean flag indicating whether or not to halt script execution when done
  • prependBase: boolean flag indicating whether or not to prepend the base URL when a relative URL is provided
  • code: integer HTTP status code to use with redirect. Should be between 300 and 307.
_redirect() sets the Location header in the response object. If you set the exit flag to false, you can override this header later in code execution.

If the exit flag is true (true by default), _redirect() will write and close the current session, if any.

  • access: protected
void _redirect (string $url, [ $options = null])
  • string $url
  • array $options: Options to be used when redirecting
_setInvokeArgs (line 286)

Set invocation arguments

  • access: protected
Zend_Controller_Action _setInvokeArgs ([ $args = array()])
  • array $args
_setParam (line 577)

Set a parameter in the $_request.

  • access: protected
Zend_Controller_Action _setParam (string $paramName, mixed $value)
  • string $paramName
  • mixed $value
__call (line 477)

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.

  • access: public
void __call (string $methodName, array $args)
  • string $methodName
  • array $args

Documentation generated on Fri, 06 Apr 2007 18:15:14 -0700 by phpDocumentor 1.3.1