documentation/manual/ja/module_specs/Zend_Controller-ActionHelpers-FlashMessenger.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20765 -->
   4 <sect3 id="zend.controller.actionhelpers.flashmessenger">
   5     <title>FlashMessenger</title>
   6
   7     <sect4 id="zend.controller.actionhelper.flashmessenger.introduction">
   8         <title>導入</title>
   9
  10         <para>
  11             <emphasis>FlashMessenger</emphasis> ヘルパーは、
  12             次のリクエストの際にユーザに見せる必要のあるメッセージを渡すためのものです。
  13             この機能を実現するため、<emphasis>FlashMessenger</emphasis> は
  14             <classname>Zend_Session_Namespace</classname> を使用してメッセージを保管しています。
  15             <classname>Zend_Session</classname> や
  16             <classname>Zend_Session_Namespace</classname> を使用する際には、起動ファイル中で
  17             <methodname>Zend_Session::start()</methodname> を実行するようにしましょう
  18             (詳細な使用例は <link linkend="zend.session.advanced_usage.starting_a_session">Zend Session</link>
  19             のドキュメントを参照ください)。
  20         </para>
  21
  22     </sect4>
  23
  24     <sect4 id="zend.controller.actionhelper.flashmessenger.basicusage">
  25         <title>基本的な使用例</title>
  26
  27         <para>
  28             以下の使用例は、もっとも基本的なフラッシュメッセンジャーの使用法を示すものです。
  29             アクション <filename>/some/my</filename> がコールされると、フラッシュメッセージに
  30             "Record Saved!" が保存されます。そして、その次のアクション
  31             <filename>/some/my-next-request</filename> へのリクエストの際にそれを取得
  32             (そして削除) します。
  33         </para>
  34
  35         <programlisting language="php"><![CDATA[
  36 class SomeController extends Zend_Controller_Action
  37 {
  38     /**
  39      * FlashMessenger
  40      *
  41      * @var Zend_Controller_Action_Helper_FlashMessenger
  42      */
  43     protected $_flashMessenger = null;
  44
  45     public function init()
  46     {
  47         $this->_flashMessenger =
  48             $this->_helper->getHelper('FlashMessenger');
  49         $this->initView();
  50     }
  51
  52     public function myAction()
  53     {
  54         /**
  55          * Zend_Controller_Action_Helper_FlashMessenger
  56          * のインスタンスを必要に応じて取得するための
  57          * デフォルトメソッド
  58          */
  59         $this->_flashMessenger->addMessage('Record Saved!');
  60     }
  61
  62     public function myNextRequestAction()
  63     {
  64         $this->view->messages = $this->_flashMessenger->getMessages();
  65         $this->render();
  66     }
  67 }
  68 ]]></programlisting>
  69     </sect4>
  70 </sect3>