<!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>Stop buffering write requests to the Phar archive, and save changes to disk</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="phar.startbuffering.html">Phar::startBuffering</a></div> <div class="next" style="text-align: right; float: right;"><a href="phar.uncompressallfiles.html">Phar::uncompressAllFiles</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.stopbuffering" class="refentry"> <div class="refnamediv"> <h1 class="refname">Phar::stopBuffering</h1> <p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::stopBuffering</span> — <span class="dc-title">Stop buffering write requests to the Phar archive, and save changes to disk</span></p> </div> <div class="refsect1 description" id="refsect1-phar.stopbuffering-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>Phar::stopBuffering</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>Phar::stopBuffering()</strong></span> is used in conjunction with the <span class="function"><a href="phar.startbuffering.html" class="function">Phar::startBuffering()</a></span> method. <span class="function"><a href="phar.startbuffering.html" class="function">Phar::startBuffering()</a></span> can provide a significant performance boost when creating or modifying a Phar archive with a large number of files. Ordinarily, every time a file within a Phar archive is created or modified in any way, the entire Phar archive will be recreated with the changes. In this way, the archive will be up-to-date with the activity performed on it. </p> <p class="para"> However, this can be unnecessary when simply creating a new Phar archive, when it would make more sense to write the entire archive out at once. Similarly, it is often necessary to make a series of changes and to ensure that they all are possible before making any changes on disk, similar to the relational database concept of transactions. The <span class="function"><a href="phar.startbuffering.html" class="function">Phar::startBuffering()</a></span>/ <span class="function"><strong>Phar::stopBuffering()</strong></span> pair of methods is provided for this purpose. </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.stopbuffering-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No value is returned. </p> </div> <div class="refsect1 errors" id="refsect1-phar.stopbuffering-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> <a href="class.pharexception.html" class="classname">PharException</a> is thrown if any problems are encountered flushing changes to disk. </p> </div> <div class="refsect1 examples" id="refsect1-phar.stopbuffering-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-701"> <p><strong>Example #1 A <span class="function"><strong>Phar::stopBuffering()</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">$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">$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">getStub</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">setStub</span><span style="color: #007700">(</span><span style="color: #DD0000">"<?php<br />function __autoload(\$class)<br />{<br /> include 'phar://brandnewphar.phar/' . str_replace('_', '/', \$class) . '.php';<br />}<br />Phar::mapPhar('brandnewphar.phar');<br />include 'phar://brandnewphar.phar/startup.php';<br />__HALT_COMPILER();"</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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">getStub</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> string(24) "<?php __HALT_COMPILER();" string(195) "<?php function __autoload($class) { include 'phar://' . str_replace('_', '/', $class); } Phar::mapPhar('brandnewphar.phar'); include 'phar://brandnewphar.phar/startup.php'; __HALT_COMPILER();" </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-phar.stopbuffering-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.isbuffering.html" class="function" rel="rdfs-seeAlso">Phar::isBuffering()</a> - Used to determine whether Phar write operations are being buffered, or are flushing directly 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.startbuffering.html">Phar::startBuffering</a></div> <div class="next" style="text-align: right; float: right;"><a href="phar.uncompressallfiles.html">Phar::uncompressAllFiles</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>