documentation/manual/en/module_specs/Zend_Controller-ActionHelpers-ActionStack.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect3 id="zend.controller.actionhelpers.actionstack">
   4     <title>ActionStack</title>
   5
   6     <para>
   7         The <emphasis>ActionStack</emphasis> helper allows you to push requests to the
   8         <link linkend="zend.controller.plugins.standard.actionstack">ActionStack</link>
   9         front controller plugin, effectively helping you create a queue of
  10         actions to execute during the request. The helper allows you to add
  11         actions either by specifying new request objects or
  12         action - controller - module sets.
  13     </para>
  14
  15     <note>
  16         <title>Invoking ActionStack Helper Initializes the ActionStack Plugin</title>
  17
  18         <para>
  19             Invoking the <emphasis>ActionStack</emphasis> helper implicitly registers
  20             the <emphasis>ActionStack</emphasis> plugin -- which means you do not need
  21             to explicitly register the <emphasis>ActionStack</emphasis> plugin to use
  22             this functionality.
  23         </para>
  24     </note>
  25
  26     <example id="zend.controller.actionhelpers.actionstack.simple">
  27         <title>Adding a Task Using Action, Controller and Module Names</title>
  28
  29         <para>
  30             Often, it's simplest to simply specify the action, controller, and
  31             module (and optional request parameters), much as you would when
  32             calling <methodname>Zend_Controller_Action::_forward()</methodname>:
  33         </para>
  34
  35         <programlisting language="php"><![CDATA[
  36 class FooController extends Zend_Controller_Action
  37 {
  38     public function barAction()
  39     {
  40         // Add two actions to the stack
  41         // Add call to /foo/baz/bar/baz
  42         // (FooController::bazAction() with request var bar == baz)
  43         $this->_helper->actionStack('baz',
  44                                     'foo',
  45                                     'default',
  46                                     array('bar' => 'baz'));
  47
  48         // Add call to /bar/bat
  49         // (BarController::batAction())
  50         $this->_helper->actionStack('bat', 'bar');
  51     }
  52 }
  53 ]]></programlisting>
  54     </example>
  55
  56     <example id="zend.controller.actionhelpers.actionstack.simple2">
  57         <title>Adding a Task Using a Request Object</title>
  58
  59         <para>
  60             Sometimes the <acronym>OOP</acronym> nature of a request object makes most sense; you
  61             can pass such an object to the <emphasis>ActionStack</emphasis> helper as
  62             well.
  63         </para>
  64
  65         <programlisting language="php"><![CDATA[
  66 class FooController extends Zend_Controller_Action
  67 {
  68     public function barAction()
  69     {
  70         // Add two actions to the stack
  71         // Add call to /foo/baz/bar/baz
  72         // (FooController::bazAction() with request var bar == baz)
  73         $request = clone $this->getRequest();
  74         // Don't set controller or module; use current values
  75         $request->setActionName('baz')
  76                 ->setParams(array('bar' => 'baz'));
  77         $this->_helper->actionStack($request);
  78
  79         // Add call to /bar/bat
  80         // (BarController::batAction())
  81         $request = clone $this->getRequest();
  82         // don't set module; use current value
  83         $request->setActionName('bat')
  84                 ->setControllerName('bar');
  85         $this->_helper->actionStack($request);
  86     }
  87 }
  88 ]]></programlisting>
  89     </example>
  90 </sect3>
  91 <!--
  92 vim:se ts=4 sw=4 et:
  93 -->