archived-doc-fr/reference/zip/ziparchive/replacefile.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c142be811735a5542c8a2e4c4ed2f81e8cc3acc6 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="ziparchive.replacefile" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZipArchive::replaceFile</refname>
  <refpurpose>Remplace un fichier d'une archive ZIP</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="ZipArchive">
   <modifier>public</modifier> <type>bool</type><methodname>ZipArchive::replaceFile</methodname>
   <methodparam><type>string</type><parameter>filepath</parameter></methodparam>
   <methodparam><type>int</type><parameter>index</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer><constant>ZipArchive::LENGTH_TO_END</constant></initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Remplace un fichier d'une archive ZIP avec un fichier donné.
  </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>index</parameter></term>
     <listitem>
      <para>
       L'index du fichier à remplacer ; son nom restera inchangé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       Pour une copie partielle, la position de départ.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Pour copie partielle, longueur à copier,
       Si <constant>ZipArchive::LENGTH_TO_END</constant> (0) est spécifié, la taille du fichier est utilisée.
       Si <constant>ZipArchive::LENGTH_UNCHECKED</constant> est spécifié, la totalité du fichier est utilisée
       (à partir de <parameter>start</parameter>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Un masque composé d'une des constantes suivantes :
       <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>.
       Le comportement de ces constantes est décrit 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.3.0, PECL zip1.22.1</entry>
       <entry>
        <constant>ZipArchive::FL_OPEN_FILE_NOW</constant> a été ajouté.
       </entry>
      </row>
      <row>
       <entry>8.3.0, PECL zip1.22.2</entry>
       <entry>
        <constant>ZipArchive::LENGTH_TO_END</constant> et <constant>ZipArchive::LENGTH_UNCHECKED</constant> ont été ajoutés.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
    <para>
     Cet exemple ouvre un fichier archive ZIP
     <filename>test.zip</filename> et remplace l'index 1 par
     <filename>/path/to/index.txt</filename>.
    </para>
    <example>
     <title>Ouvre et remplace</title>
     <programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
if ($zip->open('test.zip') === TRUE) {
    $zip->replaceFile('/path/to/index.txt', 1);
    $zip->close();
    echo 'ok';
} else {
    echo 'échec';
}
?>
]]>
     </programlisting>
    </example>
   </refsect1>

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