<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Examples</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="zip.constants.html">Predefined Constants</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="up"><a href="book.zip.html">Zip</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="zip.examples" class="chapter">
<h1>Examples</h1>
<div class="example" id="example-776">
<p><strong>Example #1 Create a Zip archive</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">"./test112.zip"</span><span style="color: #007700">;<br /><br />if (</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">CREATE</span><span style="color: #007700">)!==</span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> exit(</span><span style="color: #DD0000">"cannot open <</span><span style="color: #0000BB">$filename</span><span style="color: #DD0000">>\n"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">"testfilephp.txt" </span><span style="color: #007700">. </span><span style="color: #0000BB">time</span><span style="color: #007700">(), </span><span style="color: #DD0000">"#1 This is a test string added as testfilephp.txt.\n"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">"testfilephp2.txt" </span><span style="color: #007700">. </span><span style="color: #0000BB">time</span><span style="color: #007700">(), </span><span style="color: #DD0000">"#2 This is a test string added as testfilephp2.txt.\n"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #0000BB">$thisdir </span><span style="color: #007700">. </span><span style="color: #DD0000">"/too.php"</span><span style="color: #007700">,</span><span style="color: #DD0000">"/testfromfile.php"</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"numfiles: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">numFiles </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"status:" </span><span style="color: #007700">. </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">status </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-777">
<p><strong>Example #2 Dump the archive details and listing</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$za </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'test_with_comment.zip'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$za</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$za</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"numFiles: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">numFiles </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"status: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">status </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"statusSys: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">statusSys </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"filename: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">filename </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"comment: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">comment </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br />for (</span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700"><</span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">numFiles</span><span style="color: #007700">;</span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> echo </span><span style="color: #DD0000">"index: </span><span style="color: #0000BB">$i</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">statIndex</span><span style="color: #007700">(</span><span style="color: #0000BB">$i</span><span style="color: #007700">));<br />}<br />echo </span><span style="color: #DD0000">"numFile:" </span><span style="color: #007700">. </span><span style="color: #0000BB">$za</span><span style="color: #007700">-></span><span style="color: #0000BB">numFiles </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-778">
<p><strong>Example #3 Zip stream wrapper, read an OpenOffice meta info</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$reader </span><span style="color: #007700">= new </span><span style="color: #0000BB">XMLReader</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'zip://' </span><span style="color: #007700">. </span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">) . </span><span style="color: #DD0000">'/test.odt#meta.xml'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$odt_meta </span><span style="color: #007700">= array();<br />while (</span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">read</span><span style="color: #007700">()) {<br /> if (</span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">nodeType </span><span style="color: #007700">== </span><span style="color: #0000BB">XMLREADER</span><span style="color: #007700">::</span><span style="color: #0000BB">ELEMENT</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$elm </span><span style="color: #007700">= </span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">name</span><span style="color: #007700">;<br /> } else {<br /> if (</span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">nodeType </span><span style="color: #007700">== </span><span style="color: #0000BB">XMLREADER</span><span style="color: #007700">::</span><span style="color: #0000BB">END_ELEMENT </span><span style="color: #007700">&& </span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">name </span><span style="color: #007700">== </span><span style="color: #DD0000">'office:meta'</span><span style="color: #007700">) {<br /> break;<br /> }<br /> if (!</span><span style="color: #0000BB">trim</span><span style="color: #007700">(</span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">)) {<br /> continue;<br /> }<br /> </span><span style="color: #0000BB">$odt_meta</span><span style="color: #007700">[</span><span style="color: #0000BB">$elm</span><span style="color: #007700">] = </span><span style="color: #0000BB">$reader</span><span style="color: #007700">-></span><span style="color: #0000BB">value</span><span style="color: #007700">;<br /> }<br />}<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$odt_meta</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<p class="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 <var class="filename">test2.zip</var> archive used in this
example is one of the test archives in the ZZIPlib source
distribution.
</p>
<div class="example" id="example-779">
<p><strong>Example #4 Zip Usage Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$zip </span><span style="color: #007700">= </span><span style="color: #0000BB">zip_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/test2.zip"</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$zip</span><span style="color: #007700">) {<br /> while (</span><span style="color: #0000BB">$zip_entry </span><span style="color: #007700">= </span><span style="color: #0000BB">zip_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Name: " </span><span style="color: #007700">. </span><span style="color: #0000BB">zip_entry_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Actual Filesize: " </span><span style="color: #007700">. </span><span style="color: #0000BB">zip_entry_filesize</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Compressed Size: " </span><span style="color: #007700">. </span><span style="color: #0000BB">zip_entry_compressedsize</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Compression Method: " </span><span style="color: #007700">. </span><span style="color: #0000BB">zip_entry_compressionmethod</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /> if (</span><span style="color: #0000BB">zip_entry_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip</span><span style="color: #007700">, </span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"File Contents:\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$buf </span><span style="color: #007700">= </span><span style="color: #0000BB">zip_entry_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">, </span><span style="color: #0000BB">zip_entry_filesize</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">));<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$buf</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">zip_entry_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip_entry</span><span style="color: #007700">);<br /> }<br /> echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /> }<br /><br /> </span><span style="color: #0000BB">zip_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip</span><span style="color: #007700">);<br /><br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="zip.constants.html">Predefined Constants</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="up"><a href="book.zip.html">Zip</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
