<!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>Switch on/off autorendering</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.yaf-dispatcher.html">Yaf_Dispatcher</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-dispatcher.catchexception.html">Yaf_Dispatcher::catchException</a></div>
<div class="up"><a href="class.yaf-dispatcher.html">Yaf_Dispatcher</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="yaf-dispatcher.autorender" class="refentry">
<div class="refnamediv">
<h1 class="refname">Yaf_Dispatcher::autoRender</h1>
<p class="verinfo">(Yaf >=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Dispatcher::autoRender</span> — <span class="dc-title">Switch on/off autorendering</span></p>
</div>
<div class="refsect1 description" id="refsect1-yaf-dispatcher.autorender-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.yaf-dispatcher.html" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span> <span class="methodname"><strong>Yaf_Dispatcher::autoRender</strong></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$flag</code></span>
] )</div>
<p class="para rdfs-comment">
<a href="class.yaf-dispatcher.html" class="classname">Yaf_Dispatcher</a> will render automatically after
dispatches a incoming request, you can prevent the rendering by calling
this method with <em><code class="parameter">flag</code></em> <strong><code>TRUE</code></strong>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
you can simply return <strong><code>FALSE</code></strong> in a action to prevent the auto-rendering of
that action
</p>
</p></blockquote>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-yaf-dispatcher.autorender-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">flag</code></em></span>
<dd>
<p class="para">
bool
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
since 2.2.0, if this parameter is not given, then the current state
will be renturned
</p>
</p></blockquote>
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-yaf-dispatcher.autorender-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 examples" id="refsect1-yaf-dispatcher.autorender-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4126">
<p><strong>Example #1 <span class="function"><strong>Yaf_Dispatcher::autoRender()</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 </span><span style="color: #007700">{<br /> </span><span style="color: #FF8000">/* init method will be called as soon as a controller is initialized */ <br /> </span><span style="color: #007700">public function </span><span style="color: #0000BB">init</span><span style="color: #007700">() {<br /> if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">getRequest</span><span style="color: #007700">()-></span><span style="color: #0000BB">isXmlHttpRequest</span><span style="color: #007700">()) {<br /> </span><span style="color: #FF8000">//do not call render for ajax request<br /> //we will outpu a json string<br /> </span><span style="color: #0000BB">Yaf_Dispatcher</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">()-></span><span style="color: #0000BB">autoRender</span><span style="color: #007700">(</span><span style="color: #0000BB">FALSE</span><span style="color: #007700">);<br /> }<br /> } <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>
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.yaf-dispatcher.html">Yaf_Dispatcher</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-dispatcher.catchexception.html">Yaf_Dispatcher::catchException</a></div>
<div class="up"><a href="class.yaf-dispatcher.html">Yaf_Dispatcher</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
