ftp_fget

(PHP 4, PHP 5, PHP 7, PHP 8)

ftp_fgetDownloads a file from the FTP server and saves to an open file

Descrição

ftp_fget(
    FTP\Connection$ftp,
    resource$stream,
    string$remote_filename,
    int$mode = FTP_BINARY,
    int$offset = 0
): bool

ftp_fget() retrieves remote_filename from the FTP server, and writes it to the given file pointer.

Parâmetros

ftp

Uma instância de FTP\Connection.

stream

An open file pointer in which we store the data.

remote_filename

The remote file path.

mode

The transfer mode. Must be either FTP_ASCII or FTP_BINARY.

offset

The position in the remote file to start downloading from.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Registro de Alterações

VersãoDescrição
8.1.0 O parâmetro ftp agora espera uma instância de FTP\Connection; anteriormente, um resource era esperado.
7.3.0 The mode parameter is now optional. Formerly it has been mandatory.

Exemplos

Exemplo #1 ftp_fget() example

<?php

// path to remote file
$remote_file = 'somefile.txt';
$local_file = 'localfile.txt';

// open some file to write to
$handle = fopen($local_file, 'w');

// set up basic connection
$ftp = ftp_connect($ftp_server);

// login with username and password
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

// try to download $remote_file and save it to $handle
if (ftp_fget($ftp, $handle, $remote_file, FTP_ASCII, 0)) {
echo
"successfully written to $local_file\n";
} else {
echo
"There was a problem while downloading $remote_file to $local_file\n";
}

// close the connection and the file handler
ftp_close($ftp);
fclose($handle);
?>

Veja Também

  • ftp_get() - Downloads a file from the FTP server
  • ftp_nb_get() - Retrieves a file from the FTP server and writes it to a local file (non-blocking)
  • ftp_nb_fget() - Retrieves a file from the FTP server and writes it to an open file (non-blocking)
To Top