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)
Manual
Code Examples

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

ftp_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

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 or FTP_BINARY.

offset

The position in the remote file to start downloading from.

Return Values

Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.

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.

Related Functions

Example of ftp_nb_get

Show all examples for ftp_nb_get

PHP Version: