Zend_Controller_Action
is an abstract class you may use
for implementing Action Controllers for use with the Front
Controller when building a website based on the
Model-View-Controller (MVC) pattern.
To use Zend_Controller_Action, you will need to subclass it in your actual action controllers (or subclass it to create your own base class for action controllers). The most basic operation is to subclass it, and create action methods that correspond to the various actions you wish the controller to handle for your site. Zend_Controller's routing and dispatch handling will autodiscover any methods ending in 'Action' in your class as potential controller actions.
For example, let's say your class is defined as follows:
class FooController extends Zend_Controller_Action { public function barAction() { // do something } public function bazAction() { // do something } }
The above FooController class (controller 'foo') defines two actions, 'bar' and 'baz'.
There's much more that can be accomplished than this, such as custom initialization actions, default actions to call should no action (or an invalid action) be specified, pre- and post-dispatch hooks, and a variety of helper methods. This chapter serves as an overview of the action controller functionality
While you can always override the action controller's constructor, we do not recommend this. Zend_Controller_Action::__construct() performs some important tasks, such as registring the request and response objects, as well as any custom invocation arguments passed in from the front controller. If you must override the constructor, be sure to call parent::__construct($request, $response, $invokeArgs).
The more appropriate way to customize instantiation is to use the init() method, which is called as the last task of __construct(). For example, if you want to connect to a database at instantiation:
class FooController extends Zend_Controller_Action { public function init() { $this->db = Zend_Db::factory('Pdo_Mysql', array( 'host' => 'myhost', 'username' => 'user', 'password' => 'XXXXXXX', 'dbname' => 'website' )); } }
Zend_Controller_Action specifies two methods that may be called to bookend a requested action, preDispatch() and postDispatch(). These can be useful in a variety of ways: verifying authentication and ACLs prior to running an action (by calling _forward() in preDispatch(), the action will be skipped), for instance, or placing generated content in a sitewide template (postDispatch()).
A number of objects and variables are registered with the object, and each has accessor methods.
Request Object: getRequest() may be used to retrieve the request object used to call the action.
Response Object: getResponse() may be used to retrieve the response object aggregating the final response. Some typical calls might look like:
$this->getResponse()->setHeader('Content-Type', 'text/xml'); $this->getResponse()->appendBody($content);
Invocation Arguments: the front controller may push parameters into the router, dispatcher, and action controller. To retrieve these, use getInvokeArg($key); alternatively, fetch the entire list using getInvokeArgs().
Request parameters: The request object aggregates request parameters, such as any _GET or _POST parameters, or user parameters specified in the URL's path information. To retrieve these, use _getParam($key) or _getAllParams(). You may also set request parameters using _setParam(); this is useful when forwarding to additional actions.
To test whether or not a parameter exists (useful for logical branching), use _hasParam($key).
Besides the accessors, Zend_Controller_Action has several utility methods for performing common tasks from within your action methods (or from pre-/post-dispatch).
_forward($action, $controller = null, $module = null, array $params = null): perform another action. If called in preDispatch(), the currently requested action will be skipped in favor of the new one. Otherwise, after the current action is processed, the action requested in _forward() will be executed.
_redirect($url, array $options = array()): redirect to another location. This method takes a URL and an optional set of options. By default, it performs an HTTP 302 redirect.
The options may include one or more of the following:
exit: whether or not to exit immediately. If requested, it will cleanly close any open sessions and perform the redirect.
You may set this option globally within the
controller using the setRedirectExit()
accessor.
prependBase: whether or not to prepend the base URL registered with the request object to the URL provided.
You may set this option globally within the
controller using the
setRedirectPrependBase()
accessor.
code: what HTTP code to utilize in the redirect. By default, an HTTP 302 is utilized; any code between 301 and 306 may be used.
You may set this option globally within the
controller using the
setRedirectCode()
accessor.
render($action = null, $name = null, $noController
= false): render a view script. If no arguments
are passed, it assumes that the script requested is
[controller]/[action].phtml
(where
.phtml
is the value of the
$viewSuffix
property). Passing a value for
$action
will render that template in the
[controller]
subdirectory. To override using
the [controller]
subdirectory, pass a true
value for $noController
. Finally, templates are
rendered into the response object; if you wish to render to
a specific named segment in the response object, pass a
value to $name
.
Some examples:
<?php class MyController extends Zend_Controller_Action { public function fooAction() { // Renders my/foo.phtml $this->render(); // Renders my/bar.phtml $this->render('bar'); // Renders baz.phtml $this->render('baz', null, true); // Renders foo/login.phtml to the 'form' segment of the response object $this->render('login', 'form'); // Renders site.phtml to the 'page' segment of the response object $this->render('site', 'page', true); } }
initView(): initialize the view object.
render()
calls initView()
in order
to retrieve the view object, but it may be initialized at
any time; by default it populates the $view
property. By default, it uses Zend_View
, but
any class implementing Zend_View_Interface
may
be used.
The default implementation makes the following assumption of the directory structure:
applicationOrModule/ controllers/ IndexController.php views/ scripts/ index/ index.phtml helpers/ filters/
In other words, view scripts are assumed to be in the
views/scripts/
subdirectory, and the
views
subdirectory is assumed to be a sibling
of the controllers subdirectory.
Call initView()
in either init()
or your action methods if you need to be able to assign
variables, register filters, etc. As examples:
<?php class MyController extends Zend_Controller_Action { public function init() { // Initialize view object immediately $this->initView(); } public function fooAction() { // Initialize some variables $this->view->foo = 'bar'; $this->view->bar = 'baz'; // render the view, with the 'foo' and 'bar' assigned variables $this->render(); } } class FooController extends Zend_Controller_Action { public function barAction() { // Initialize view on a per-action basis: $view = $this->initView(); // Initialize some variables $view->foo = 'bar'; $view->bar = 'baz'; // render the view, with the 'foo' and 'bar' assigned variables $this->render(); } }
getViewScript($action = null, $noController =
false): retrieve a view script path.
Primarily used by render()
, you can call this
at any time to grab a view script path, or override the
method to change how your controller determines the path to
a view script.
As detailed under render()
, above, the default
functionality is to look for a view script named
[controller]/[action].phtml
. Providing
$action
will override the filename of the view
script, and passing a true value to
$noController
will override looking in the
controller subdirectory. You may also override the
$viewSuffix
property to change the file
extension used (defaults to .phtml).
Override this method to provide alternate functionality when determining the view script name and path.