mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 23:38:56 +00:00
f45d3cb110
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@251096 c90b9560-bf6c-de11-be94-00142212c4b1
111 lines
3.3 KiB
XML
111 lines
3.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.startbuffering">
|
|
<refnamediv>
|
|
<refname>Phar::startBuffering</refname>
|
|
<refpurpose>Start buffering Phar write operations, do not modify the Phar object on disk</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>Phar::startBuffering</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
Although technically unnecessary, the <function>startBuffering</function> 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.
|
|
</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>startBuffering</function>/<function>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="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>Phar::startBuffering</function> example</title>
|
|
<para>
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// make sure it doesn't exist
|
|
@unlink('brandnewphar.phar');
|
|
try {
|
|
$p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
|
|
} catch (Exception $e) {
|
|
echo 'Could not create phar:', $e;
|
|
}
|
|
echo 'The new phar has ' . $p->count() . " entries\n";
|
|
$p->startBuffering();
|
|
$p['file.txt'] = 'hi';
|
|
$p['file2.txt'] = 'there';
|
|
$p['file2.txt']->setCompressedGZ();
|
|
$p['file3.txt'] = 'babyface';
|
|
$p['file3.txt']->setMetaData(42);
|
|
$p->setStub("<?php
|
|
function __autoload($class)
|
|
{
|
|
include 'phar://myphar.phar/' . str_replace('_', '/', $class) . '.php';
|
|
}
|
|
Phar::mapPhar('myphar.phar');
|
|
include 'phar://myphar.phar/startup.php';
|
|
__HALT_COMPILER();");
|
|
$p->stopBuffering();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>Phar::stopBuffering</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:"../../../../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
|
|
-->
|