<!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>Used to determine whether Phar write operations are being buffered, or are flushing directly to disk</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.interceptfilefuncs.html">Phar::interceptFileFuncs</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.iscompressed.html">Phar::isCompressed</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.isbuffering" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::isBuffering</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::isBuffering</span> — <span class="dc-title">Used to determine whether Phar write operations are being buffered, or are flushing directly to disk</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.isbuffering-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Phar::isBuffering</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
This method can be used to determine whether a Phar will save changes
to disk immediately, or whether a call to <span class="function"><a href="phar.stopbuffering.html" class="function">Phar::stopBuffering()</a></span>
is needed to enable saving changes.
</p>
<p class="para">
Phar write buffering is per-archive, buffering active for the
<em>foo.phar</em> Phar archive does not affect changes
to the <em>bar.phar</em> Phar archive.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.isbuffering-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the write operations are being buffer, <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.isbuffering-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-685">
<p><strong>Example #1 A <span class="function"><strong>Phar::isBuffering()</strong></span> example</strong></p>
<div class="example-contents"><p>
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">) . </span><span style="color: #DD0000">'/brandnewphar.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'existingphar.phar'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file1.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">isBuffering</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p2</span><span style="color: #007700">-></span><span style="color: #0000BB">isBuffering</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?><br /></span>=2=<br /><span style="color: #0000BB"><?php<br />$p</span><span style="color: #007700">-></span><span style="color: #0000BB">startBuffering</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">isBuffering</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p2</span><span style="color: #007700">-></span><span style="color: #0000BB">isBuffering</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">stopBuffering</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?><br /></span>=3=<br /><span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">isBuffering</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p2</span><span style="color: #007700">-></span><span style="color: #0000BB">isBuffering</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(false)
bool(false)
=2=
bool(true)
bool(false)
=3=
bool(false)
bool(false)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.isbuffering-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.startbuffering.html" class="function" rel="rdfs-seeAlso">Phar::startBuffering()</a> - Start buffering Phar write operations, do not modify the Phar object on disk</span></li>
<li class="member"> <span class="function"><a href="phar.stopbuffering.html" class="function" rel="rdfs-seeAlso">Phar::stopBuffering()</a> - Stop buffering write requests to the Phar archive, and save changes to disk</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.interceptfilefuncs.html">Phar::interceptFileFuncs</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.iscompressed.html">Phar::isCompressed</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
