PHP ftp_nb_get() Function

Definition and Usage

The ftp_nb_get() function retrieves a file from an FTP server and writes it to a local file (non-blocking).

This function returns the following values:

  • FTP_FAILED (send/receive failed)
  • FTP_FINISHED (send/receive completed)
  • FTP_MOREDATA (send/receive in progress)

With ftp_get() Different, this function retrieves files asynchronously. This means that your program can perform other operations while the file transfer is in progress.

Syntax

ftp_nb_get(ftp_connection,local,remote,mode,resume)
Parameters Description
ftp_connection Required. Specifies the FTP connection to use (the identifier for the FTP connection).
local Required. Specifies the local file to write to. If the file already exists, it will be overwritten.
remote Required. Specifies the path of the file to copy from.
mode

Required. Specifies the transfer mode. Possible values include:

  • FTP_ASCII
  • FTP_BINARY
resume Required. Specifies where to start copying in the remote file. The default is 0.

Example

This example copies text from "source.txt" to "target.txt":

<?php
$conn = ftp_connect("ftp.testftp.com") or die("Could not connect");
ftp_login($conn,"admin","ert456");
ftp_nb_get($conn,"target.txt","source.txt",FTP_ASCII);
ftp_close($conn);
?>