doc-fr/reference/zip/ziparchive/addfile.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c0a030bf35b5eac2701ba97788f9e49cdbfdf049 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="ziparchive.addfile" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::addFile</refname>
  <refpurpose>Ajoute un fichier à l'archive ZIP depuis le chemin fourni</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <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>
   Ajoute un fichier à une archive ZIP depuis le chemin fourni.
  </para>
  &zip.filename.separator;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filepath</parameter></term>
     <listitem>
      <para>
       Le chemin vers le fichier à ajouter
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>entryname</parameter></term>
     <listitem>
      <para>
       Si fourni, ce sera le nom local dans l'archive ZIP qui écrasera
       le contenu du paramètre <parameter>filepath</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       Pour copie partielle, position de départ.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Pour copie partielle, longeur à copier, si 0 ou -1 le fichier entier (à
       partir de <parameter>start</parameter>) est utilisé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Masque de bit consistant de
       <constant>ZipArchive::FL_OVERWRITE</constant>,
       <constant>ZipArchive::FL_ENC_GUESS</constant>,
       <constant>ZipArchive::FL_ENC_UTF_8</constant>,
       <constant>ZipArchive::FL_ENC_CP437</constant>.
       Le comportement de ces constantes est décrites sur la page des
       <link linkend="zip.constants">constantes ZIP</link>.
      </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> a été ajouté.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
    <para>
     Cet exemple ouvre l'archive ZIP <filename>test.zip</filename>
     et ajoute le fichier <filename>/path/to/index.txt</filename>,
     en tant que <filename>newname.txt</filename>.
    </para>
    <example>
     <title>Ouverture et ajout</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
    $zip->addFile('/chemin/vers/index.txt', 'newname.txt');
    $zip->close();
    echo 'ok';
} else {
    echo 'échec';
}
?>
]]>
     </programlisting>
    </example>
   </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Lorsqu'un fichier est marqué comme étant à ajouter à l'archive, PHP va 
    verrouiller ce fichier. Le verrou sera relaché uniquement lorsque l'objet 
    <classname>ZipArchive</classname> sera fermé, soit via 
    <methodname>ZipArchive::close</methodname> soit via destruction de l'objet 
    <classname>ZipArchive</classname>. Ceci peut vous empêcher de supprimer le 
    fichier en cours d'ajout même après que le verrou soit 
    relaché.       
   </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
-->