ftp_nb_get

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

ftp_nb_get — Lee un fichero en un servidor FTP y lo escribe en un fichero (no bloqueante)

Descripción

ftp_nb_get(
    FTP\Connection $ftp,
    string $local_filename,
    string $remote_filename,
    int $mode = FTP_BINARY,
    int $offset = 0
): int|false

ftp_nb_get() lee el fichero remote_filename presente en el servidor FTP ftp y lo guarda en un fichero local.

La diferencia entre esta función y ftp_fget() es que esta función puede leer el fichero de manera asíncrona, para que el programa realice otras tareas mientras el fichero se descarga.

Parámetros

ftp: Una instancia de FTP\Connection.
local_filename: La ruta hacia el fichero local (será sobrescrito si el fichero ya existe).
remote_filename: La ruta hacia el fichero remoto.
mode: El modo de transferencia. Debe ser FTP_ASCII o FTP_BINARY.
offset: La posición en el fichero remoto a partir de la cual debe comenzar la descarga.

Valores devueltos

Devuelve FTP_FAILED o FTP_FINISHED o FTP_MOREDATA, o false en caso de fallo al abrir el fichero local.

Historial de cambios

Versión	Descripción
8.1.0	El parámetro `ftp` ahora espera una instancia de FTP\Connection ; anteriormente, se esperaba un resource.
7.3.0	El argumento `mode` ahora es opcional. Anteriormente era obligatorio.

Ejemplos

Ejemplo #1 Ejemplo con ftp_nb_get()

<?php

// Inicia la descarga
$ret = ftp_nb_get($ftp, "test", "README", FTP_BINARY);
while ($ret == FTP_MOREDATA) {

   // Realice lo que desee...
   echo ".";

   // Continúa la descarga...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "Hubo un problema durante la descarga...";
   exit(1);
}
?>

Ejemplo #2 Reanudación de una descarga con ftp_nb_get()

<?php

// Inicializa
$ret = ftp_nb_get($ftp, "test", "README", FTP_BINARY,
                      filesize("test"));
// O: $ret = ftp_nb_get($ftp, "test", "README",
//                           FTP_BINARY, FTP_AUTORESUME);
while ($ret == FTP_MOREDATA) {

   // Realice lo que desee...
   echo ".";

   // Continúa la descarga...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "Hubo un problema durante la descarga del fichero...";
   exit(1);
}
?>

Ejemplo #3 Reanudación de una descarga desde la posición 100 en un nuevo fichero con ftp_nb_get()

<?php

// Desactiva AutoSeek
ftp_set_option($ftp, FTP_AUTOSEEK, false);

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

   /* ... */

   // Continúa la descarga...
   $ret = ftp_nb_continue($ftp);
}
?>

En el ejemplo anterior, newfile es 100 bytes más pequeño que README en el sitio FTP, ya que comenzamos a leer desde el offset 100. Si no hubiéramos desactivado la opción FTP_AUTOSEEK, los primeros 100 bytes del fichero newfile serían rellenados con '\0'.

Ver también

ftp_nb_fget() - Lee un fichero en un servidor FTP y lo escribe en un fichero (no bloqueante)
ftp_nb_continue() - Reanuda la descarga de un fichero (no bloqueante)
ftp_fget() - Descarga un fichero a través de FTP en un fichero local
ftp_get() - Descarga un fichero desde un servidor FTP

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

passerbyxp at gmail dot com ¶

13 years ago

Note that you may have to keep calling ftp_nb_continue in order to complete the download. For example, if you do this:

<?php
ftp_nb_get($conn,$localfile,$remotefile,FTP_BINARY)
//do some LONG time work
while(ftp_nb_continue($conn)!=FTP_FINISHED){}
?>

Your local file may only contains a few kilobytes and the later ftp_nb_continue will keep raising warning of no more data (due to connection time out, I guess).

So you may want to do this instead:

<?php
$dl=ftp_nb_get($conn,$localfile,$remotefile,FTP_BINARY)
//part of long time work
if(ftp_nb_continue($conn)==FTP_MOREDATA) {}
//part of long time work
if(ftp_nb_continue($conn)==FTP_MOREDATA) {}
//continue to do this until you finish the long time work
while(ftp_nb_continue($conn)==FTP_MOREDATA){}
?>

This happened on my Windows XP + PHP 5.3.8 under CLI. Hope this helps someone.

＋add a note