<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-controller-abstract.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'yaf-controller-abstract.forward.php',
    1 => 'Yaf_Controller_Abstract::forward',
    2 => '別のアクションに転送する',
  ),
  'up' => 
  array (
    0 => 'class.yaf-controller-abstract.php',
    1 => 'Yaf_Controller_Abstract',
  ),
  'prev' => 
  array (
    0 => 'yaf-controller-abstract.display.php',
    1 => 'Yaf_Controller_Abstract::display',
  ),
  'next' => 
  array (
    0 => 'yaf-controller-abstract.getinvokearg.php',
    1 => 'Yaf_Controller_Abstract::getInvokeArg',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/yaf/yaf_controller_abstract/forward.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-controller-abstract.forward" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yaf_Controller_Abstract::forward</h1>
  <p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Controller_Abstract::forward</span> &mdash; <span class="dc-title">別のアクションに転送する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-controller-abstract.forward-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Yaf_Controller_Abstract::forward</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$action</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$paramters</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>Yaf_Controller_Abstract::forward</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$controller</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$action</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$paramters</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>Yaf_Controller_Abstract::forward</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$module</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$controller</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$action</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$paramters</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   現在の実行プロセスを別のアクションに転送します。
   <blockquote class="note"><p><strong class="note">注意</strong>: 
    <p class="para">
      このメソッドは、その場ですぐに次のアクションに切り替えるわけではなく、
      現在の実行フローが終わってから次のアクションに転送します。
    </p>
   </p></blockquote>
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-controller-abstract.forward-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">module</code></dt>
    <dd>
     <p class="para">
       移動先のモジュール名。NULL を渡した場合はデフォルトのモジュール名と見なします。
     </p>
    </dd>
   
   
    <dt><code class="parameter">controller</code></dt>
    <dd>
     <p class="para">
       移動先のコントローラ名。
     </p>
    </dd>
   
   
    <dt><code class="parameter">action</code></dt>
    <dd>
     <p class="para">
       移動先のアクション名。
     </p>
    </dd>
   
   
    <dt><code class="parameter">paramters</code></dt>
    <dd>
     <p class="para">
      呼び出しの引数。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yaf-controller-abstract.forward-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-controller-abstract.forward-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 <span class="function"><strong>Yaf_Controller_Abstract::forward()</strong></span> の例</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">IndexController </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Controller_Abstract<br /></span><span style="color: #007700">{<br />    public function </span><span style="color: #0000BB">indexAction</span><span style="color: #007700">(){   <br />         </span><span style="color: #0000BB">$logined </span><span style="color: #007700">= </span><span style="color: #0000BB">$_SESSION</span><span style="color: #007700">[</span><span style="color: #DD0000">"login"</span><span style="color: #007700">];<br />         if (!</span><span style="color: #0000BB">$logined</span><span style="color: #007700">) {<br />             </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">forward</span><span style="color: #007700">(</span><span style="color: #DD0000">"login"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"from" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"Index"</span><span style="color: #007700">)); </span><span style="color: #FF8000">// login アクションに転送します<br />             </span><span style="color: #007700">return </span><span style="color: #0000BB">FALSE</span><span style="color: #007700">;  </span><span style="color: #FF8000">// これが重要です。ここで現在の作業フローが終了し、<br />                            // Yaf に対して自動レンダリングをしないよう指示します。<br />         </span><span style="color: #007700">}<br /><br />         </span><span style="color: #FF8000">// 別の処理<br />    </span><span style="color: #007700">}<br /><br />    public function </span><span style="color: #0000BB">loginAction</span><span style="color: #007700">() {<br />         echo </span><span style="color: #DD0000">"login, redirected from "</span><span style="color: #007700">, </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">_request</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getParam</span><span style="color: #007700">(</span><span style="color: #DD0000">"from"</span><span style="color: #007700">) , </span><span style="color: #DD0000">" action"</span><span style="color: #007700">;<br />    }<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>上の例の出力は、
たとえば以下のようになります。</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">login, redirected from Index action</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-controller-abstract.forward-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="methodname"><strong>Yaf_Request_Abstrace::getParam()</strong></span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>