doc-fr/reference/ftp/functions/ftp-nb-get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.ftp-nb-get" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_nb_get</refname>
  <refpurpose>Lit un fichier sur un serveur FTP, et l'écrit dans un fichier (non bloquant)</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>ftp_nb_get</methodname>
   <methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
   <methodparam><type>string</type><parameter>local_filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>remote_filename</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>FTP_BINARY</constant></initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>ftp_nb_get</function> lit le fichier <parameter>remote_filename</parameter>
   présent sur le serveur FTP <parameter>ftp</parameter> et le sauvegarde
   dans un fichier local. 
  </para>
  <para>
   La différence entre cette fonction et <function>ftp_fget</function> est
   que cette fonction peut lire le fichier de manière asynchrone, afin
   que votre programme fasse autre chose pendant que le fichier
   est téléchargé.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ftp</parameter></term>
     <listitem>
      &ftp.parameter.ftp;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>local_filename</parameter></term>
     <listitem>
      <para>
       Le chemin vers le fichier local (sera écrasé si le fichier existe déjà).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>remote_filename</parameter></term>
     <listitem>
      <para>
       Le chemin vers le fichier distant.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Le mode de transfert. Doit être soit <constant>FTP_ASCII</constant> ou
       <constant>FTP_BINARY</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       La position dans le fichier distant à partir de laquelle
       le téléchargement doit commencer.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne <constant>FTP_FAILED</constant> ou <constant>FTP_FINISHED</constant>
   ou <constant>FTP_MOREDATA</constant>.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &ftp.changelog.ftp-param;
     <row>
      <entry>7.3.0</entry>
      <entry>
       Le paramètre <parameter>mode</parameter> est maintenant optionnel. Précédemment il
       était obligatoire.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>ftp_nb_get</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Initialise le téléchargement
$ret = ftp_nb_get($ftp, "test", "README", FTP_BINARY);
while ($ret == FTP_MOREDATA) {
   
   // Faites ce que vous voulez...
   echo ".";

   // Continue le téléchargement...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "Il y a eu un problème lors du téléchargement...";
   exit(1);
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Reprise d'un téléchargement avec <function>ftp_nb_get</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Initialise
$ret = ftp_nb_get($ftp, "test", "README", FTP_BINARY,
                      filesize("test"));
// Ou : $ret = ftp_nb_get($ftp, "test", "README",
//                           FTP_BINARY, FTP_AUTORESUME);
while ($ret == FTP_MOREDATA) {
   
   // Faites ce que vous voulez...
   echo ".";

   // Continue le téléchargement...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "Il y a eu un problème lors du téléchargement du fichier...";
   exit(1);
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>
     Reprise d'un téléchargement à la position 100 dans un nouveau fichier avec
     <function>ftp_nb_get</function>
    </title>
    <programlisting role="php">
<![CDATA[
<?php

// Désactive l'Autoseek
ftp_set_option($ftp, FTP_AUTOSEEK, false);

// Initialisation
$ret = ftp_nb_get($ftp, "newfile", "README", FTP_BINARY, 100);
while ($ret == FTP_MOREDATA) {

   /* ... */
   
   // Continue le téléchargement...
   $ret = ftp_nb_continue($ftp);
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   Dans l'exemple ci-dessus, <filename>newfile</filename> est 100
   octets plus petit que <filename>README</filename> sur le site FTP, car
   nous avons commencé à lire à l'offset 100. Si nous n'avions pas
   désactivé l'option <constant>FTP_AUTOSEEK</constant>, les premiers
   100 octets du fichier <filename>newfile</filename> seraient complétés
   avec <literal>'\0'</literal>.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftp_nb_fget</function></member>
    <member><function>ftp_nb_continue</function></member>
    <member><function>ftp_fget</function></member>
    <member><function>ftp_get</function></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
-->