Location: PHPKode > projects > Open Power Template > docs/Opt/api.opt-class.get-buffer-state.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="pl">
<head>
	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
	<meta name="robots" content="all" />

	<title>getBufferState() - Open Power Template</title>
	
	<link rel="stylesheet" type="text/css" href="design/generic.css" media="all"  />
	<link rel="stylesheet" type="text/css" href="design/print.css" media="print" />
	<!--[if lte IE 6]><link rel="stylesheet" href="design/ie.css" type="text/css" /><![endif]-->	
	<!--[if IE 7]><link rel="stylesheet" href="design/ie7.css" type="text/css" /><![endif]-->
</head>
<body>

<div id="wrap">
	<div id="header">
		<h1>Open Power Template 2.0</h1>
		<h2>getBufferState()</h2>
		<p class="generated">@ 02.09.2010</p>
		<p class="location"><a href="index.html"><strong>User manual</strong></a> &raquo; <a href="api.html">API Reference</a> &raquo; <a href="api.opt-class.html">Opt_Class</a> &raquo; <a href="api.opt-class.get-buffer-state.html">Opt_Class::getBufferState()</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="api.opt-class.html">7.1. Opt_Class class</a><br/>7.1.1. getBufferState()</dt><dd class="prev">7.1. Opt_Class class<br/><a href="api.opt-class.html">&laquo; Previous</a></dd><dd class="next">7.1.2. getCache()<br/><a href="api.opt-class.get-cache.html">Next &raquo;</a></dd></dl>	<h1>7.1.1. getBufferState()</h1><div class="tf_reference"><table><tr><th>Construct</th><td>Method</td></tr><tr><th>Visibility</th><td>public</td></tr><tr><th>Reference</th><td><code>boolean getBufferState( string $name )</code></td></tr><tr><th>Argument list</th><td><dl><dt><code>$name</code> <small>- string</small></dt><dd>The buffer name</dd></dl></td></tr><tr><th>Returned value</th><td>The state of the output buffer.</td></tr><tr><th>Versions</th><td>since <code>2.0.1</code></td></tr>
</table><hr/></div><p>Open Power Template supports advisory notifications on the output buffer state. They can help deciding, whether to open a new output buffer or using an existing one. Advisory output buffer states are a kind of semaphores. <code>getBufferState()</code> returns <strong>true</strong>, if the value of the buffer semaphore is greater than zero and <strong>false</strong> otherwise.</p>

<pre class="php"><a href="http://www.php.net/ob_start"><span style="color: #990000;">ob_start</span></a><span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
<span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">setBufferState</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'buffer'</span><span style="color: #339933;">,</span> <span style="color: #009900; font-weight: bold;">true</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
&nbsp;
<span style="color: #666666; font-style: italic;">// ...</span>
&nbsp;
<span style="color: #b1b100;">if</span><span style="color: #009900;">&#40;</span><span style="color: #339933;">!</span><span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">getBufferState</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'buffer'</span><span style="color: #009900;">&#41;</span><span style="color: #009900;">&#41;</span>
<span style="color: #009900;">&#123;</span>
    <a href="http://www.php.net/ob_start"><span style="color: #990000;">ob_start</span></a><span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
    <span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">setBufferState</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'buffer'</span><span style="color: #339933;">,</span> <span style="color: #009900; font-weight: bold;">true</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
<span style="color: #009900;">&#125;</span>
&nbsp;
<span style="color: #666666; font-style: italic;">// ...</span>
&nbsp;
<a href="http://www.php.net/ob_end_flush"><span style="color: #990000;">ob_end_flush</span></a><span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
<span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">setBufferState</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'buffer'</span><span style="color: #339933;">,</span> <span style="color: #009900; font-weight: bold;">false</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span></pre>

<p>Advisory output buffer states are mostly used in OPT caching systems.</p>
<h4>See also:</h4><ul><li><a href="api.opt-class.set-buffer-state.html">7.1.7. Opt_Class::setBufferState()</a></li><li><a href="extending.caching-systems.html">5.6. New caching systems</a></li></ul><dl class="location location-bottom"><dt>7.1.1. getBufferState()<br/><a href="api.opt-class.html">7.1. Opt_Class class</a></dt><dd class="prev"><a href="api.opt-class.html">&laquo; Previous</a><br/>7.1. Opt_Class class</dd><dd class="next"><a href="api.opt-class.get-cache.html">Next &raquo;</a><br/>7.1.2. getCache()</dd></dl>		</div>
	
	<div id="footer">
		<p>Copyright &copy; <a href="http://www.invenzzia.org/">Invenzzia Group 2008-2009</a></p>
		<p>Available under the terms of license: <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License 1.2</a></p>
		<p>Generated by <strong>TypeFriendly 0.1.4</strong> by <a href="http://www.invenzzia.org/">Invenzzia</a></p>
	</div>
</div>

</body>
</html>
Return current item: Open Power Template