addfile.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.addfile" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::addFile</refname>
  <refpurpose>Adds a file to a ZIP archive from the given path</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ZipArchive">
   <modifier>public</modifier> <type>bool</type><methodname>ZipArchive::addFile</methodname>
   <methodparam><type>string</type><parameter>filepath</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>entryname</parameter><initializer>""</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ZipArchive::FL_OVERWRITE</initializer></methodparam>
  </methodsynopsis>
  <para>
   Adds a file to a ZIP archive from a given path.
  </para>
  &zip.filename.separator;
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filepath</parameter></term>
     <listitem>
      <para>
       The path to the file to add.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>entryname</parameter></term>
     <listitem>
      <para>
       If supplied and not empty, this is the local name inside the ZIP archive that will override the <parameter>filepath</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       For partial copy, start position.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       For partial copy, length to be copied, if 0 or -1 the whole file (starting from <parameter>start</parameter>) is used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Bitmask consisting of
       <constant>ZipArchive::FL_OVERWRITE</constant>,
       <constant>ZipArchive::FL_ENC_GUESS</constant>,
       <constant>ZipArchive::FL_ENC_UTF_8</constant>,
       <constant>ZipArchive::FL_ENC_CP437</constant>,
       <constant>ZipArchive::FL_OPEN_FILE_NOW</constant>.
       The behaviour of these constants is described on the
       <link linkend="zip.constants">ZIP constants</link> page.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0 / 1.18.0</entry>
       <entry>
        <parameter>flags</parameter> was added.
       </entry>
      </row>
      <row>
       <entry>8.3.0 / 1.22.1</entry>
       <entry>
        <constant>ZipArchive::FL_OPEN_FILE_NOW</constant> was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
    <para>
     This example opens a ZIP file archive
     <filename>test.zip</filename> and add
     the file <filename>/path/to/index.txt</filename>.
     as <filename>newname.txt</filename>.
    </para>
    <example>
     <title>Open and add</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
    $zip->addFile('/path/to/index.txt', 'newname.txt');
    $zip->close();
    echo 'ok';
} else {
    echo 'failed';
}
?>
]]>
     </programlisting>
    </example>
   </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    When a file is set to be added to the archive, PHP will lock the file. The
    lock is only released once the <classname>ZipArchive</classname> object
    has been closed, either via <methodname>ZipArchive::close</methodname> or
    the <classname>ZipArchive</classname> object being destroyed. This may
    prevent you from being able to delete the file being added until after the
    lock has been released.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>ZipArchive::replaceFile</methodname></member>
   </simplelist>
  </para>
 </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
-->