<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="phar.stopbuffering" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Phar::stopBuffering</refname>
  <refpurpose>Stop buffering write requests to the Phar archive, and save changes to disk</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Phar">
   <modifier>public</modifier> <type>void</type><methodname>Phar::stopBuffering</methodname>
   <void/>
  </methodsynopsis>

  <para>
   <function>Phar::stopBuffering</function> is used in conjunction with the
   <function>Phar::startBuffering</function> method.  <function>Phar::startBuffering</function>
   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.
  </para>
  <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
   <function>Phar::startBuffering</function>/<function>Phar::stopBuffering</function> pair
   of methods is provided for this purpose.
  </para>
  <para>
   Phar write buffering is per-archive, buffering active for the
   <literal>foo.phar</literal> Phar archive does not affect changes
   to the <literal>bar.phar</literal> Phar archive.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <classname>PharException</classname> is thrown if any problems are encountered
   flushing changes to disk.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>Phar::stopBuffering</function> example</title>
    <para>
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
$p['file1.txt'] = 'hi';
$p->startBuffering();
var_dump($p->getStub());
$p->setStub("<?php
function __autoload(\$class)
{
    include 'phar://brandnewphar.phar/' . str_replace('_', '/', \$class) . '.php';
}
Phar::mapPhar('brandnewphar.phar');
include 'phar://brandnewphar.phar/startup.php';
__HALT_COMPILER();");
$p->stopBuffering();
var_dump($p->getStub());
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
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();"
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Phar::startBuffering</function></member>
    <member><function>Phar::isBuffering</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
