## Zend_Controller_Action

Description

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

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

Variable Summary
Zend_Controller_Dispatcher_Token $_action
Method Summary
Zend_Controller_Action __construct ()
void indexAction ()
void run (Zend_Controller_Dispatcher_Interface $dispatcher, Zend_Controller_Dispatcher_Token $action)
void _forward (string $controllerName, string $actionName, [array $params = array()])
array _getAllParams ()
boolean _getParam (string $paramName, [string $default = null])
void _redirect (string $url)
void __call (string $methodName, array $args)
Variables
Zend_Controller_Dispatcher_Token $_action = null (line 38)

Zend_Controller_Dispatcher_Token object wrapping this controller/action call.

- access: protected

Methods
Constructor __construct (line 72)

Class constructor

- access: public

Zend_Controller_Action __construct ()
indexAction (line 66)

Any controller extending Zend_Controller_Action must provide an index() method. The index() method is the default action for the controller when no action is specified.

This only handles a controller which has been called with no action specified in the URI.

For handling nonexistant actions in controllers (bad action part of URI), the controller class must provide a __call() method or an exception will be thrown.

- access: public
- abstract:

void indexAction ()
run (line 101)

Initialize the class instance variables and then call the action.

- access: public

void run (Zend_Controller_Dispatcher_Interface $dispatcher, Zend_Controller_Dispatcher_Token $action)

- Zend_Controller_Dispatcher_Token $action
- Zend_Controller_Dispatcher_Interface $dispatcher

_forward (line 178)

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 Zend_Controller_Dispatcher_Token item is received.

- access: protected

void _forward (string $controllerName, string $actionName, [array $params = array()])

- string $controllerName
- string $actionName
- array $params

_getAllParams (line 161)

Return all parameters that were passed to the controller as an associative array.

- access: protected

array _getAllParams ()
_getParam (line 141)

Gets a parameter that was passed to this controller. If the parameter does not exist, FALSE will be return.

If the parameter does not exist and $default is set, then $default will be returned instead of FALSE.

- access: protected

boolean _getParam (string $paramName, [string $default = null])

- string $paramName
- string $default

_redirect (line 189)

Redirect to another URL

- access: protected

void _redirect (string $url)

- string $url

__call (line 84)

Proxy for undefined methods. Default behavior is to throw an exception on undefined methods, however this function can be overrided to implement magic (dynamic) actions.

- access: public

void __call (string $methodName, array $args)

- string $methodName
- array $args

Documentation generated on Tue, 11 Jul 2006 12:16:30 -0500 by phpDocumentor 1.3.0RC6