No cache version.
Caching disabled. Default setting for this page:enabled (code LNG204)If the display is too slow, you can disable the user mode to view the cached version.
ftp_nb_get
(PHP 4 >= 4.3.0, PHP 5, PHP 7)
ftp_nb_get — Retrieves a file from the FTP server and writes it to a local file (non-blocking)
Description
$ftp_stream
, string $local_file
, string $remote_file
[, int $mode = FTP_IMAGE
[, int $resumepos = 0
]] ) : intftp_nb_get() retrieves a remote file from the FTP server, and saves it into a local file.
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_stream -
The link identifier of the FTP connection.
-
local_file -
The local file path (will be overwritten if the file already exists).
-
remote_file -
The remote file path.
-
mode -
The transfer mode. Must be either
FTP_ASCIIorFTP_BINARY. -
resumepos -
The position in the remote file to start downloading from.
Changelog
| Version | Description |
|---|---|
| 7.3.0 |
The mode parameter is now optional. Formerly it
has been mandatory.
|
Examples
Example #1 ftp_nb_get() example
<?php
// Initate the download
$ret = ftp_nb_get($my_connection, "test", "README", FTP_BINARY);
while ($ret == FTP_MOREDATA) {
// Do whatever you want
echo ".";
// Continue downloading...
$ret = ftp_nb_continue($my_connection);
}
if ($ret != FTP_FINISHED) {
echo "There was an error downloading the file...";
exit(1);
}
?>
Example #2 Resuming a download with ftp_nb_get()
<?php
// Initate
$ret = ftp_nb_get($my_connection, "test", "README", FTP_BINARY,
filesize("test"));
// OR: $ret = ftp_nb_get($my_connection, "test", "README",
// FTP_BINARY, FTP_AUTORESUME);
while ($ret == FTP_MOREDATA) {
// Do whatever you want
echo ".";
// Continue downloading...
$ret = ftp_nb_continue($my_connection);
}
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($my_connection, FTP_AUTOSEEK, false);
// Initiate
$ret = ftp_nb_get($my_connection, "newfile", "README", FTP_BINARY, 100);
while ($ret == FTP_MOREDATA) {
/* ... */
// Continue downloading...
$ret = ftp_nb_continue($my_connection);
}
?>
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, the first 100 bytes of
newfile would be '\0'.
See Also
- ftp_nb_fget() - Retrieves a file from the FTP server and writes it to an open file (non-blocking)
- ftp_nb_continue() - Continues retrieving/sending a file (non-blocking)
- ftp_fget() - Downloads a file from the FTP server and saves to an open file
- ftp_get() - Downloads a file from the FTP server
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-ftp-nb-get.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
