php-doc-en/reference/zip/reference.xml
2006-04-02 14:39:17 +00:00

125 lines
3.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- Purpose: compression -->
<!-- Membership: pecl -->
<reference id="ref.zip">
<title>Zip File Functions (Read Only Access)</title>
<titleabbrev>Zip</titleabbrev>
<partintro>
<section id="zip.intro">
&reftitle.intro;
<para>
This module enables you to transparently read ZIP compressed
archives and the files inside them.
</para>
</section>
<section id="zip.requirements">
&reftitle.required;
<para>
This module uses the functions of the <ulink
url="&url.zziplib;">ZZIPlib</ulink> library by Guido Draheim.
You need ZZIPlib version &gt;= 0.10.6.
</para>
<para>
The PECL package version 1.1.0 and up does not require any external
library. It also provides a write mode (creations and modifications).
The new features are not yet documented, please check the examples
included in the releases.
</para>
<para>
Note that ZZIPlib only provides a subset of functions
provided in a full implementation of the ZIP compression algorithm
and can only read ZIP file archives. A normal ZIP utility is
needed to create the ZIP file archives read by this library.
</para>
</section>
&reference.zip.configure;
<section id="zip.configuration">
&reftitle.runtime;
&no.config;
</section>
<section id="zip.resources">
&reftitle.resources;
&no.resource;
</section>
<section id="zip.constants">
&reftitle.constants;
&no.constants;
</section>
<section id="zip.examples">
&reftitle.examples;
<para>
This example 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
-->