ftp_nb_fput
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
ftp_nb_fput — Stores a file from an open file to the FTP server (non-blocking)
Description
FTP\Connection
$ftp,string
$remote_filename,resource
$stream,int
$mode = FTP_BINARY,int
$offset = 0): int
ftp_nb_fput() uploads the data from a file pointer to a remote file on the FTP server.
The difference between this function and the ftp_fput() is that this function uploads the file asynchronously, so your program can perform other operations while the file is being uploaded.
Parameters
-
ftp -
An FTP\Connection instance.
-
remote_filename -
The remote file path.
-
stream -
An open file pointer on the local file. Reading stops at end of file.
-
mode -
The transfer mode. Must be either
FTP_ASCIIorFTP_BINARY. -
offset -
The position in the remote file to start uploading to.
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.
|
Examples
Example #1 ftp_nb_fput() example
<?php
$file = 'index.php';
$fp = fopen($file, 'r');
$ftp = ftp_connect($ftp_server);
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);
// Initiate the upload
$ret = ftp_nb_fput($ftp, $file, $fp, FTP_BINARY);
while ($ret == FTP_MOREDATA) {
// Do whatever you want
echo ".";
// Continue upload...
$ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
echo "There was an error uploading the file...";
exit(1);
}
fclose($fp);
?>
See Also
- ftp_nb_put() - Stores a file on the FTP server (non-blocking)
- ftp_nb_continue() - Continues retrieving/sending a file (non-blocking)
- ftp_put() - Uploads a file to the FTP server
- ftp_fput() - Uploads from an open file to the FTP server
