open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 28f0dc949d62c97698ac4a0ca814c3780d8cf318 Maintainer: sammywg Status: ready -->
<refentry xml:id="ziparchive.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ZipArchive::open</refname>
  <refpurpose>Öffnet ein ZIP-Dateiarchiv</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ZipArchive">
   <modifier>public</modifier> <type class="union"><type>bool</type><type>int</type></type><methodname>ZipArchive::open</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Öffnet ein neues oder existierendes ZIP-Archiv für Lese-, Schreib- und
   Veränderungszugriffe.
  </para>
  <para>
   Seit libzip 1.6.0 wird eine leere Datei nicht länger als gültiges Archiv
   angesehen.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Der Name des zu öffnenden ZIP-Archivs.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Der Modus, in dem das zu öffnende Archiv verwendet werden soll.
       <itemizedlist>
        <listitem>
         <para>
          <constant>ZipArchive::OVERWRITE</constant>
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>ZipArchive::CREATE</constant>
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>ZipArchive::RDONLY</constant>
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>ZipArchive::EXCL</constant>
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>ZipArchive::CHECKCONS</constant>
         </para>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt bei Erfolg &true; zurück, bei einem Fehler &false; oder einen der
   folgenden Fehlercodes:
   <variablelist>
    <varlistentry>
     <term><constant>ZipArchive::ER_EXISTS</constant></term>
     <listitem>
      <simpara>Die Datei existiert bereits.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_INCONS</constant></term>
     <listitem>
      <simpara>Das Zip-Archiv ist inkonsistent.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_INVAL</constant></term>
     <listitem>
      <simpara>Ungültiges Argument.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_MEMORY</constant></term>
     <listitem>
      <simpara>Malloc-Fehler.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_NOENT</constant></term>
     <listitem>
      <simpara>Keine solche Datei.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_NOZIP</constant></term>
     <listitem>
      <simpara>Kein ZIP-Archiv.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_OPEN</constant></term>
     <listitem>
      <simpara>Datei konnte nicht geöffnet werden.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_READ</constant></term>
     <listitem>
      <simpara>Lesefehler.</simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><constant>ZipArchive::ER_SEEK</constant></term>
     <listitem>
      <simpara>Positionierungsfehler.</simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Öffnen und extrahieren</title>
   <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip');
if ($res === TRUE) {
    echo 'ok';
    $zip->extractTo('test');
    $zip->close();
} else {
    echo 'Fehler, Code:' . $res;
}
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Ein Archiv erstellen</title>
   <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip', ZipArchive::CREATE);
if ($res === TRUE) {
    $zip->addFromString('test.txt', 'Der Dateiinhalt kommt hier');
    $zip->addFile('data.txt', 'eintragsname.txt');
    $zip->close();
    echo 'ok';
} else {
    echo 'Fehler';
}
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Erstellen eines temporären Archivs</title>
   <programlisting role="php">
<![CDATA[
<?php
$name = tempnam(sys_get_temp_dir(), "FOO");
$zip = new ZipArchive;
$res = $zip->open($name, ZipArchive::OVERWRITE); /* trunkieren, da eine leere Datei nicht gültig ist */
if ($res === TRUE) {
    $zip->addFile('data.txt', 'eintragsname.txt');
    $zip->close();
    echo 'ok';
} else {
    echo 'Fehler';
}
?>
]]>
   </programlisting>
  </example>
 </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
-->