Zend_Controller-Plugins-ActionStack.xml 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <!-- EN-Revision: 16705 -->
  4. <sect3 id="zend.controller.plugins.standard.actionstack">
  5. <title>ActionStack</title>
  6. <para>
  7. <emphasis>ActionStack</emphasis> プラグインは、リクエストをスタックで管理します。
  8. <emphasis>postDispatch</emphasis> プラグインとして動作します。
  9. 現在のリクエストオブジェクトで既に転送先が指定されている
  10. (別のアクションがコールされている) 場合は、何も行いません。
  11. 転送されていない場合はスタックの最上位の要素を取り出し、
  12. そのリクエストが指すアクションに転送します。
  13. スタックの処理は <acronym>LIFO</acronym> (後入れ先出し) 方式で行います。
  14. </para>
  15. <para>
  16. このプラグインをフロントコントローラから取得するには、
  17. <methodname>Zend_Controller_Front::getPlugin('Zend_Controller_Plugin_ActionStack')</methodname>
  18. とします。プラグインオブジェクトを取得したら、
  19. さまざまな仕組みを利用できるようになります。
  20. </para>
  21. <itemizedlist>
  22. <listitem><para>
  23. <methodname>getRegistry()</methodname> および <methodname>setRegistry()</methodname>。
  24. <emphasis>ActionStack</emphasis> は、内部的に
  25. <classname>Zend_Registry</classname> のインスタンスを使ってスタックを管理しています。
  26. 別のレジストリインスタンスでこれを置き換えたり、
  27. インスタンスを取得したりする際にこれらのアクセサを使用します。
  28. </para></listitem>
  29. <listitem><para>
  30. <methodname>getRegistryKey()</methodname> および <methodname>setRegistryKey()</methodname>。
  31. これらは、スタックに格納する際にレジストリのどのキーを使用するかを指定します。
  32. デフォルト値は '<classname>Zend_Controller_Plugin_ActionStack</classname>' です。
  33. </para></listitem>
  34. <listitem><para>
  35. <methodname>getStack()</methodname> は、
  36. そのアクションのスタック全体を取得します。
  37. </para></listitem>
  38. <listitem><para>
  39. <methodname>pushStack()</methodname> および <methodname>popStack()</methodname>
  40. は、それぞれスタックへの追加とスタックからの取り出しを行います。
  41. <methodname>pushStack()</methodname> にはリクエストオブジェクトを渡します。
  42. </para></listitem>
  43. </itemizedlist>
  44. <para>
  45. さらに <methodname>forward()</methodname> メソッドが存在します。
  46. このメソッドにはリクエストオブジェクトを渡し、
  47. フロントコントローラにおける現在のリクエストオブジェクトの状態を
  48. ここで渡したオブジェクトの状態に設定します。
  49. そして、リクエストを未ディスパッチ状態に戻します
  50. (ディスパッチループの次の処理に強制的に進ませます)。
  51. </para>
  52. </sect3>
  53. <!--
  54. vim:se ts=4 sw=4 et:
  55. -->