ftp_nb_get

Function • Params and return types changed in PHP 8.1

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

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Improved
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

ftp_nb_get Function synopsis

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

Parameters

$ftp

TypeFTP\Connection

$local_filename

Typestring

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

$remote_filename

Typestring

The remote file path.

$mode

OptionalTypeintDefault valueFTP_BINARY

The transfer mode. Must be either FTP_ASCII or FTP_BINARY.

$offset

OptionalTypeintDefault value0

The position in the remote file to start downloading from.

Return value

Typeint|false

Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA, or false on failure to open the local file.

Changes to the ftp_nb_get Function

PHP 8.1

  • Return type changed: int to int|false
  • Parameter type added for parameter #1 ($ftp): FTP\Connection
  ftp_nb_get(
-     $ftp,
+     FTP\Connection $ftp,
      string $local_filename,
      string $remote_filename,
      int $mode = FTP_BINARY,
      int $offset = 0
-   ): int
+   ): int|false

PHP 8.0

  • Return type added: int
  • Parameter name of parameter #2 changed: $local_file to $local_filename
  • Parameter type added for parameter #2 ($local_filename): string
  • Parameter name of parameter #3 changed: $remote_file to $remote_filename
  • Parameter type added for parameter #3 ($remote_filename): string
  • Parameter type added for parameter #4 ($mode): int
  • Parameter default value added for position #4 ($mode): FTP_BINARY
  • Parameter name of parameter #5 changed: $resume_pos to $offset
  • Parameter type added for parameter #5 ($offset): int
  • Parameter default value added for position #5 ($offset): 0
  ftp_nb_get(
      $ftp,
-     $local_file,
+     string $local_filename,
-     $remote_file,
+     string $remote_filename,
-     $mode,
+     int $mode = FTP_BINARY,
-     $resume_pos
+     int $offset = 0
-   )
+   ): int

ftp_nb_get Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes