ftp_get
Downloads a file from the FTP server
Description
bool ftp_get(
FTP\Connection $ftp
,
string $local_filename
,
string $remote_filename
,
int $mode
= FTP_BINARY
,
int $offset
= 0
)
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 true
on success or false
on failure.
Examples
Example #1 ftp_get example
<?php
// define some variables
$local_file = 'local.zip';
$server_file = 'server.zip';
// set up basic connection
$ftp = ftp_connect($ftp_server);
// login with username and password
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);
// try to download $server_file and save to $local_file
if (ftp_get($ftp, $local_file, $server_file, FTP_BINARY)) {
echo "Successfully written to $local_file\n";
} else {
echo "There was a problem\n";
}
// close the connection
ftp_close($ftp);
?>
See Also
- ftp_pasv
- ftp_fget
- ftp_nb_get
- ftp_nb_fget