PHP: Hypertext Preprocessor (original) (raw)

ftp_nb_get

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

ftp_nb_get — Retrieves a file from the FTP server and writes it to a local file (non-blocking)

Description

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

Parameters

ftp

An FTP\Connection instance.

local_filename

The local file path (will be overwritten if the file already exists).

remote_filename

The remote file path.

mode

The transfer mode. Must be either [FTP_ASCII](ftp.constants.php#constant.ftp-ascii) or**[FTP_BINARY](ftp.constants.php#constant.ftp-binary)**.

offset

The position in the remote file to start downloading from.

Changelog

Version	Description
8.1.0	The ftp parameter expects an FTP\Connection instance now; previously, a resource was expected.
7.3.0	The mode parameter is now optional. Formerly it has been mandatory.

Examples

Example #1 ftp_nb_get() example

<?php// Initiate the download <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>e</mi><mi>t</mi><mo>=</mo><mi>f</mi><mi>t</mi><msub><mi>p</mi><mi>n</mi></msub><msub><mi>b</mi><mi>g</mi></msub><mi>e</mi><mi>t</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">ret = ftp_nb_get(</annotation></semantics></math>ret=ftpnbget(ftp, "test", "README", FTP_BINARY); while ($ret == FTP_MOREDATA) {// Do whatever you want echo ".";// Continue downloading... <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>e</mi><mi>t</mi><mo>=</mo><mi>f</mi><mi>t</mi><msub><mi>p</mi><mi>n</mi></msub><msub><mi>b</mi><mi>c</mi></msub><mi>o</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>n</mi><mi>u</mi><mi>e</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">ret = ftp_nb_continue(</annotation></semantics></math>ret=ftpnbcontinue(ftp); } if ($ret != FTP_FINISHED) { echo "There was an error downloading the file..."; exit(1); } ?>

Example #2 Resuming a download with ftp_nb_get()

<?php// Initiate <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>e</mi><mi>t</mi><mo>=</mo><mi>f</mi><mi>t</mi><msub><mi>p</mi><mi>n</mi></msub><msub><mi>b</mi><mi>g</mi></msub><mi>e</mi><mi>t</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">ret = ftp_nb_get(</annotation></semantics></math>ret=ftpnbget(ftp, "test", "README", FTP_BINARY, filesize("test")); // OR: <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>e</mi><mi>t</mi><mo>=</mo><mi>f</mi><mi>t</mi><msub><mi>p</mi><mi>n</mi></msub><msub><mi>b</mi><mi>g</mi></msub><mi>e</mi><mi>t</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">ret = ftp_nb_get(</annotation></semantics></math>ret=ftpnbget(ftp, "test", "README", // FTP_BINARY, FTP_AUTORESUME); while ($ret == FTP_MOREDATA) {// Do whatever you want echo ".";// Continue downloading... <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>e</mi><mi>t</mi><mo>=</mo><mi>f</mi><mi>t</mi><msub><mi>p</mi><mi>n</mi></msub><msub><mi>b</mi><mi>c</mi></msub><mi>o</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>n</mi><mi>u</mi><mi>e</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">ret = ftp_nb_continue(</annotation></semantics></math>ret=ftpnbcontinue(ftp); } if ($ret != FTP_FINISHED) { echo "There was an error downloading the file..."; exit(1); } ?>

Example #3 Resuming a download at position 100 to a new file with ftp_nb_get()

`<?php// Disable Autoseek
ftp_set_option($ftp, FTP_AUTOSEEK, false);// Initiate ret=ftpnbget(ret = ftp_nb_get(ret=ftpnbget(ftp, "newfile", "README", FTP_BINARY, 100);
while ($ret == FTP_MOREDATA) {/* ... */

// Continue downloading... ret=ftpnbcontinue(ret = ftp_nb_continue(ret=ftpnbcontinue(ftp);
}
?>`

In the example above, newfile is 100 bytes smaller than README on the FTP server because we started reading at offset 100. If we didn't disable [FTP_AUTOSEEK](ftp.constants.php#constant.ftp-autoseek), the first 100 bytes ofnewfile would be '\0'.

Found A Problem?

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:

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:

dl=ftpnbget(dl=ftp_nb_get(dl=ftpnbget(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.