ftp_nb_get

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

ftp_nb_get — Recupera um arquivo do servidor FTP e grava-o em um arquivo local (sem bloqueio)

Descrição

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

ftp_nb_get() recupera um arquivo remoto do servidor FTP grava-o em um arquivo local.

A diferença entre esta função e ftp_get() é que esta função recupera o arquivo de forma assíncrona, para que a aplicação possa realizar outras operações enquanto o arquivo está sendo recebido.

Parâmetros

ftp: Uma instância de FTP\Connection.
local_filename: O caminho do arquivo local (será substituído se o arquivo já existir).
remote_filename: O caminho do arquivo remoto.
mode: O modo de transferência. Deve ser FTP_ASCII ou FTP_BINARY.
offset: A posição no arquivo remoto para iniciar o recebimento.

Valor Retornado

Retorna FTP_FAILED ou FTP_FINISHED ou FTP_MOREDATA, ou false em caso de falha ao abrir o arquivo local.

Registro de Alterações

Versão	Descrição
8.1.0	O parâmetro `ftp` agora espera uma instância de FTP\Connection; anteriormente, um resource era esperado.
7.3.0	O parâmetro `mode` agora é opcional. Antigamente era obrigatório.

Exemplos

Exemplo #1 Exemplo de ftp_nb_get()

<?php

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

   // Faz alguma coisa
   echo ".";

   // Continua o recebimento...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "Houve um erro ao receber o arquivo...";
   exit(1);
}
?>

Exemplo #2 Continuando o recebimento com ftp_nb_get()

<?php

// Inicia
$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) {

   // Faz alguma coisa
   echo ".";

   // Continua o recebimento...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "Houve um erro ao receber o arquivo...";
   exit(1);
}
?>

Exemplo #3 Continuando o recebimento na posição 100 para um novo arquivo com ftp_nb_get()

<?php

// Desabilita a busca automática
ftp_set_option($ftp, FTP_AUTOSEEK, false);

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

   /* ... */

   // Continua o recebimento...
   $ret = ftp_nb_continue($ftp);
}
?>

No exemplo acima, newfile é 100 bytes menor que README no servidor FTP porque a leitura começou na posição 100. Se FTP_AUTOSEEK não fosse desabilitada, os primeiros 100 bytes de newfile seriam '\0'.

Veja Também

ftp_nb_fget() - Recupera um arquivo do servidor FTP e grava-o em um arquivo aberto (sem bloqueio)
ftp_nb_continue() - Continua a receber/enviar um arquivo (sem bloquear)
ftp_fget() - Recebe um arquivo do servidor FTP e salva em um arquivo aberto
ftp_get() - Recebe um arquivo do servidor FTP