php-doc-en/reference/zip/reference.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<!-- Purpose: compression -->
<!-- Membership: bundled, pecl -->

<reference xml:id="ref.zip" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>Zip File Functions</title>
 <titleabbrev>Zip</titleabbrev>

 <partintro>
  <section xml:id="zip.intro">
   &reftitle.intro;
   <para>
    This extension enables you to transparently read or write ZIP compressed
    archives and the files inside them.
   </para>
  </section>

  <section xml:id="zip.requirements">
   &reftitle.required;
   <section xml:id="zip.requirements.old">
    <title>PHP 4</title>
    <para>
     The bundled PHP 4 version requires <link xlink:href="&url.zziplib;">ZZIPlib</link>,
     by Guido Draheim, version 0.10.6 or later 
    </para>
   </section>

   <section xml:id="zip.requirements.new">
    <title>PHP 5.2.0 or later</title>
    <para>
     This extension uses the functions of <link xlink:href="&url.zlib;">zlib</link>
     by Jean-loup Gailly and Mark Adler.
    </para>
   </section>
  </section>

  &reference.zip.configure;

  <section xml:id="zip.configuration">
   &reftitle.runtime;
   &no.config;
  </section>

  <section xml:id="zip.resources">
   &reftitle.resources;
   <para>
    There are two resource types used in the Zip module. The first one
    is the Zip directory for the Zip archive, the second Zip Entry for
    the archive entries.
   </para>
  </section>

  &reference.zip.constants;

  <section xml:id="zip.examples">
   &reftitle.examples;
   <example>
    <title>Create a Zip archive</title>
    <programlisting role="php">
<![CDATA[
<?php

$zip = new ZipArchive();
$filename = "./test112.zip";

if ($zip->open($filename, ZIPARCHIVE::CREATE)!==TRUE) {
    exit("cannot open <$filename>\n");
}

$zip->addFromString("testfilephp.txt" . time(), "#1 This is a test string added as testfilephp.txt.\n");
$zip->addFromString("testfilephp2.txt" . time(), "#2 This is a test string added as testfilephp2.txt.\n");
$zip->addFile($thisdir . "/too.php","/testfromfile.php");
echo "numfiles: " . $zip->numFiles . "\n";
echo "status:" . $zip->status . "\n";
$zip->close();
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Dump the archive details and listing</title>
    <programlisting role="php">
<![CDATA[
<?php
$za = new ZipArchive();

$za->open('test_with_comment.zip');
print_r($za);
var_dump($za);
echo "numFiles: " . $za->numFiles . "\n";
echo "status: " . $za->status  . "\n";
echo "statusSys: " . $za->statusSys . "\n";
echo "filename: " . $za->filename . "\n";
echo "comment: " . $za->comment . "\n";

for ($i=0; $i<$za->numFiles;$i++) {
    echo "index: $i\n";
    print_r($za->statIndex($i));
}
echo "numFile:" . $za->numFiles . "\n";
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Zip stream wrapper, read an OpenOffice meta info</title>
    <programlisting role="php">
<![CDATA[
<?php
$reader = new XMLReader();

$reader->open('zip://' . dirname(__FILE__) . '/test.odt#meta.xml');
$odt_meta = array();
while ($reader->read()) {
    if ($reader->nodeType == XMLREADER::ELEMENT) {
        $elm = $reader->name;
    } else {
        if ($reader->nodeType == XMLREADER::END_ELEMENT && $reader->name == 'office:meta') {
            break;
        }
        if (!trim($reader->value)) {
            continue;
        }
        $odt_meta[$elm] = $reader->value;
    }
}
print_r($odt_meta);
?>
]]>
    </programlisting>
   </example>
   <para>
    This example uses the old API (PHP 4), it opens a ZIP file
    archive, reads each file in the archive and prints out its
    contents. The <filename>test2.zip</filename> archive used in this
    example is one of the test archives in the ZZIPlib source
    distribution.
   </para>
   <example>
    <title>Zip Usage Example</title>
    <programlisting role="php">
<![CDATA[
<?php

$zip = zip_open("/tmp/test2.zip");

if ($zip) {
    while ($zip_entry = zip_read($zip)) {
        echo "Name:               " . zip_entry_name($zip_entry) . "\n";
        echo "Actual Filesize:    " . zip_entry_filesize($zip_entry) . "\n";
        echo "Compressed Size:    " . zip_entry_compressedsize($zip_entry) . "\n";
        echo "Compression Method: " . zip_entry_compressionmethod($zip_entry) . "\n";

        if (zip_entry_open($zip, $zip_entry, "r")) {
            echo "File Contents:\n";
            $buf = zip_entry_read($zip_entry, zip_entry_filesize($zip_entry));
            echo "$buf\n";

            zip_entry_close($zip_entry);
        }
        echo "\n";

    }

    zip_close($zip);

}
?>
]]>
    </programlisting>
   </example>
  </section>
 </partintro>

 &reference.zip.functions;

 </reference>
<!-- 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
-->