<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>foward to another action</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-controller-abstract.display.html">Yaf_Controller_Abstract::display</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-controller-abstract.getinvokearg.html">Yaf_Controller_Abstract::getInvokeArg</a></div>
<div class="up"><a href="class.yaf-controller-abstract.html">Yaf_Controller_Abstract</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="yaf-controller-abstract.forward" class="refentry">
<div class="refnamediv">
<h1 class="refname">Yaf_Controller_Abstract::forward</h1>
<p class="verinfo">(Yaf >=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Controller_Abstract::forward</span> — <span class="dc-title">foward to another action</span></p>
</div>
<div class="refsect1 description" id="refsect1-yaf-controller-abstract.forward-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>Yaf_Controller_Abstract::forward</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$paramters</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>Yaf_Controller_Abstract::forward</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$controller</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$paramters</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>Yaf_Controller_Abstract::forward</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$module</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$controller</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$paramters</code></span>
] )</div>
<p class="para rdfs-comment">
forward current execution process to other action.
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
this method doesn't switch to the destination action immediately, it
will take place after current flow finish.
</p>
</p></blockquote>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-yaf-controller-abstract.forward-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">module</code></em></span>
<dd>
<p class="para">
destination module name, if NULL was given, then default module name
is assumed
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">controller</code></em></span>
<dd>
<p class="para">
destination controller name
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">action</code></em></span>
<dd>
<p class="para">
destination action name
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">paramters</code></em></span>
<dd>
<p class="para">
calling arguments
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 examples" id="refsect1-yaf-controller-abstract.forward-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4136">
<p><strong>Example #1 <span class="function"><strong>Yaf_Controller_Abstract::forward()</strong></span>example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?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">-></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">=> </span><span style="color: #DD0000">"Index"</span><span style="color: #007700">)); </span><span style="color: #FF8000">// forward to login action<br /> </span><span style="color: #007700">return </span><span style="color: #0000BB">FALSE</span><span style="color: #007700">; </span><span style="color: #FF8000">// this is important, this finish current working flow<br /> // and tell the Yaf do not doing auto-render<br /> </span><span style="color: #007700">}<br /><br /> </span><span style="color: #FF8000">// other processes<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">-></span><span style="color: #0000BB">_request</span><span style="color: #007700">-></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">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
login, redirected from Index action
</pre></div>
</div>
</div>
</div>
<div class="refsect1 returnvalues" id="refsect1-yaf-controller-abstract.forward-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
return FALSE on failure
</p>
</div>
<div class="refsect1 seealso" id="refsect1-yaf-controller-abstract.forward-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="methodname"><strong>Yaf_Request_Abstrace::getParam()</strong></span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-controller-abstract.display.html">Yaf_Controller_Abstract::display</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-controller-abstract.getinvokearg.html">Yaf_Controller_Abstract::getInvokeArg</a></div>
<div class="up"><a href="class.yaf-controller-abstract.html">Yaf_Controller_Abstract</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
