<!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>Extract the archive contents</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ziparchive.deletename.html">ZipArchive::deleteName</a></div> <div class="next" style="text-align: right; float: right;"><a href="ziparchive.getarchivecomment.html">ZipArchive::getArchiveComment</a></div> <div class="up"><a href="class.ziparchive.html">ZipArchive</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="ziparchive.extractto" class="refentry"> <div class="refnamediv"> <h1 class="refname">ZipArchive::extractTo</h1> <p class="verinfo">(PHP 5 >= 5.2.0, PECL zip >= 1.1.0)</p><p class="refpurpose"><span class="refname">ZipArchive::extractTo</span> — <span class="dc-title">Extract the archive contents</span></p> </div> <div class="refsect1 description" id="refsect1-ziparchive.extractto-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>ZipArchive::extractTo</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$destination</code></span> [, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$entries</code></span> ] )</div> <p class="para rdfs-comment"> Extract the complete archive or the given files to the specified destination. </p> </div> <div class="refsect1 parameters" id="refsect1-ziparchive.extractto-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">destination</code></em></span> <dd> <p class="para"> Location where to extract the files. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">entries</code></em></span> <dd> <p class="para"> The entries to extract. It accepts either a single entry name or an array of names. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-ziparchive.extractto-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-ziparchive.extractto-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-788"> <p><strong>Example #1 Extract all entries</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<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: #DD0000">'test.zip'</span><span style="color: #007700">) === </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">extractTo</span><span style="color: #007700">(</span><span style="color: #DD0000">'/my/destination/dir/'</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 /> echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'failed'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> <div class="example" id="example-789"> <p><strong>Example #2 Extract two entries</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<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">$res </span><span style="color: #007700">= </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: #DD0000">'test_im.zip'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">extractTo</span><span style="color: #007700">(</span><span style="color: #DD0000">'/my/destination/dir/'</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'pear_item.gif'</span><span style="color: #007700">, </span><span style="color: #DD0000">'testfromfile.php'</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 /> echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'failed'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ziparchive.deletename.html">ZipArchive::deleteName</a></div> <div class="next" style="text-align: right; float: right;"><a href="ziparchive.getarchivecomment.html">ZipArchive::getArchiveComment</a></div> <div class="up"><a href="class.ziparchive.html">ZipArchive</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>