ftp_nb_fget

Retrieves a file from the FTP server and writes it to an open file (non-blocking) (PHP 4 >= 4.3.0, PHP 5)
int ftp_nb_fget ( resource ftp_stream, resource handle, string remote_file, int mode [, int resumepos] )

ftp_nb_fget() retrieves a remote file from the FTP server.

The difference between this function and ftp_fget() is that this function retrieves the file asynchronously, so your program can perform other operations while the file is being downloaded.

Parameters

ftp_stream: The link identifier of the FTP connection.
handle: An open file pointer in which we store the data.
remote_file: The remote file path.
mode: The transfer mode. Must be either FTP_ASCII or FTP_BINARY.
resumepos

Return Values

Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.

Examples

Example 732. ftp_nb_fget() example

copy to clipboard

<?php

// open some file for reading
$file = 'index.php';
$fp = fopen($file, 'w');

$conn_id = ftp_connect($ftp_server);

$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);

// Initate the download
$ret = ftp_nb_fget($conn_id, $fp, $file, FTP_BINARY);

while ($ret == FTP_MOREDATA) {


   // Do whatever you want

   echo ".";


   // Continue downloading...

   $ret = ftp_nb_continue($conn_id);

}

if ($ret != FTP_FINISHED) {

   echo "There was an error downloading the file...";

   exit(1);

}

// close filepointer
fclose($fp);
?>

See Also

ftp_nb_get()

ftp_nb_continue()

ftp_fget()

ftp_get()

If you want to monitor the progress of the download, you may use the filesize()-Function. But note: The results of said function are cached, so you'll always get 0 bytes. Call clearstatcache() before calling filesize() to determine the actual size of the downloaded file. This may have performance implications, but if you want to provide the information, there's no way around it. Above sample extended: <?php // get the size of the remote file $fs = ftp_size($my_connection, "test"); // Initate the download $ret = ftp_nb_get($my_connection, "test", "README", FTP_BINARY); while ($ret == FTP_MOREDATA) { clearstatcache(); // <- this is important $dld = filesize($locfile); if ( $dld > 0 ){ // calculate percentage $i = ($dld/$fs)*100; printf("\r\t%d%% downloaded", $i); } // Continue downloading... $ret = ftp_nb_continue ($my_connection); } if ($ret != FTP_FINISHED) { echo "There was an error downloading the file..."; exit(1); } ?> Philip

ftp_nb_fget

Retrieves a file from the FTP server and writes it to an open file (non-blocking) (PHP 4 >= 4.3.0, PHP 5)
int ftp_nb_fget ( resource ftp_stream, resource handle, string remote_file, int mode [, int resumepos] )

Parameters

Return Values

Examples

Example 732. ftp_nb_fget() example

Code Examples / Notes » ftp_nb_fget

Change Language

ftp_nb_fget

Retrieves a file from the FTP server and writes it to an open file (non-blocking) (PHP 4 >= 4.3.0, PHP 5) int ftp_nb_fget ( resource ftp_stream, resource handle, string remote_file, int mode [, int resumepos] )

Parameters

Return Values

Examples

Example 732. ftp_nb_fget() example

Code Examples / Notes » ftp_nb_fget

Change Language

Retrieves a file from the FTP server and writes it to an open file (non-blocking) (PHP 4 >= 4.3.0, PHP 5)
int ftp_nb_fget ( resource ftp_stream, resource handle, string remote_file, int mode [, int resumepos] )