<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.extractto" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::extractTo</refname>
  <refpurpose>Extract the archive contents</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ZipArchive">
   <modifier>public</modifier> <type>bool</type><methodname>ZipArchive::extractTo</methodname>
   <methodparam><type>string</type><parameter>pathto</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>files</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Extract the complete archive or the given files to the specified
   destination.
  </para>
  <warning>
   <para>
    The default permissions for extracted files and directories
    give the widest possible access. This can be restricted
    by setting the current umask, which can be changed using
    <function>umask</function>.
   </para>
   <para>
    For security reasons, the original permissions are not restored.
    For an example of how to restore them, see the
    <link linkend="ziparchive.getexternalattributesindex.examples.perms">code sample</link>
    on the <methodname>ZipArchive::getExternalAttributesIndex</methodname> page.
   </para>
  </warning>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>pathto</parameter></term>
     <listitem>
      <para>
       Location where to extract the files.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>files</parameter></term>
     <listitem>
      <para>
       The entries to extract. It accepts either a single entry name or
       an array of names.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
    <example>
     <title>Extract all entries</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
    $zip->extractTo('/my/destination/dir/');
    $zip->close();
    echo 'ok';
} else {
    echo 'failed';
}
?>
]]>
     </programlisting>
    </example>
    <example>
     <title>Extract two entries</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
$res = $zip->open('test_im.zip');
if ($res === TRUE) {
    $zip->extractTo('/my/destination/dir/', array('pear_item.gif', 'testfromfile.php'));
    $zip->close();
    echo 'ok';
} else {
    echo 'failed';
}
?>
]]>
     </programlisting>
    </example>
   </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.extractto-windows;
 </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
-->
