<!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>Start buffering Phar write operations, do not modify the Phar object on disk</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.setstub.html">Phar::setStub</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.stopbuffering.html">Phar::stopBuffering</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.startbuffering" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::startBuffering</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::startBuffering</span> — <span class="dc-title">Start buffering Phar write operations, do not modify the Phar object on disk</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.startbuffering-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::startBuffering</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Although technically unnecessary, the <span class="function"><strong>Phar::startBuffering()</strong></span> method
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"><strong>Phar::startBuffering()</strong></span>/ <span class="function"><a href="phar.stopbuffering.html" class="function">Phar::stopBuffering()</a></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.startbuffering-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.startbuffering-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-700">
<p><strong>Example #1 A <span class="function"><strong>Phar::startBuffering()</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 /></span><span style="color: #FF8000">// make sure it doesn't exist<br /></span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />try {<br /> </span><span style="color: #0000BB">$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 />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Could not create phar:'</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br />echo </span><span style="color: #DD0000">'The new phar has ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">count</span><span style="color: #007700">() . </span><span style="color: #DD0000">" entries\n"</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">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.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: #DD0000">'file2.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'there'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file2.txt'</span><span style="color: #007700">]-></span><span style="color: #0000BB">setCompressedGZ</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file3.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'babyface'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file3.txt'</span><span style="color: #007700">]-></span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(</span><span style="color: #0000BB">42</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(</span><span style="color: #0000BB">$class</span><span style="color: #DD0000">)<br />{<br /> include 'phar://myphar.phar/' . str_replace('_', '/', </span><span style="color: #0000BB">$class</span><span style="color: #DD0000">) . '.php';<br />}<br />Phar::mapPhar('myphar.phar');<br />include 'phar://myphar.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">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.startbuffering-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<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>
<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.setstub.html">Phar::setStub</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.stopbuffering.html">Phar::stopBuffering</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>
