<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="phar.compressfiles" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Phar::compressFiles</refname>
  <refpurpose>Compresses all files in the current Phar archive</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Phar">
   <modifier>public</modifier> <type>void</type><methodname>Phar::compressFiles</methodname>
   <methodparam><type>int</type><parameter>compression</parameter></methodparam>
  </methodsynopsis>
  &phar.write;

  <para>
   For tar-based phar archives, this method throws a
   <classname>BadMethodCallException</classname>, as compression of individual
   files within a tar archive is not supported by the file format.  Use
   <function>Phar::compress</function> to compress an entire tar-based phar archive.
  </para>
  <para>
   For Zip-based and phar-based phar archives, this method compresses all files in the
   Phar archive using the specified compression.
   The <link linkend="ref.zlib">zlib</link>  or <link linkend="ref.bzip2">bzip2</link>
   extensions must be enabled to take advantage of this feature.  In addition, if any files
   are already compressed using bzip2/zlib compression, the respective extension must be
   enabled in order to decompress the files prior to re-compressing.
   As with all functionality that modifies the contents of a phar, the
   <link linkend="ini.phar.readonly">phar.readonly</link> INI variable must be off
   in order to succeed.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>compression</parameter></term>
     <listitem>
      <para>
       Compression must be one of <literal>Phar::GZ</literal>,
       <literal>Phar::BZ2</literal> to add compression, or <literal>Phar::NONE</literal>
       to remove compression.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws <classname>BadMethodCallException</classname> if
   the <link linkend="ini.phar.readonly">phar.readonly</link>
   INI variable is on, the <link linkend="ref.zlib">zlib</link>
   extension is not available, or if any files are compressed using
   bzip2 compression and the <link linkend="ref.bzip2">bzip2</link> extension
   is not enabled.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>Phar::compressFiles</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressed(Phar::BZ2));
    var_dump($file->isCompressed(Phar::GZ));
}
$p->compressFiles(Phar::GZ);
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressed(Phar::BZ2));
    var_dump($file->isCompressed(Phar::GZ));
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(10) "myfile.txt"
bool(false)
bool(false)
bool(false)
string(11) "myfile2.txt"
bool(false)
bool(false)
bool(false)
string(10) "myfile.txt"
int(4096)
bool(false)
bool(true)
string(11) "myfile2.txt"
int(4096)
bool(false)
bool(true)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>PharFileInfo::getCompressedSize</function></member>
    <member><function>PharFileInfo::isCompressed</function></member>
    <member><function>PharFileInfo::compress</function></member>
    <member><function>PharFileInfo::decompress</function></member>
    <member><function>Phar::canCompress</function></member>
    <member><function>Phar::isCompressed</function></member>
    <member><function>Phar::decompressFiles</function></member>
    <member><function>Phar::getSupportedCompression</function></member>
    <member><function>Phar::compress</function></member>
    <member><function>Phar::decompress</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
-->
