FTP_GET(3) 1 FTP_GET(3)
ftp_get - Downloads a file from the FTP server
SYNOPSIS
bool ftp_get (resource $ftp_stream, string $local_file, string $remote_file, int $mode, [int $resumepos])
DESCRIPTION
ftp_get(3) retrieves a remote file from the FTP server, and saves it into a local file.
PARAMETERS
o $ftp_stream
- The link identifier of the FTP connection.
o $local_file
- The local file path (will be overwritten if the file already exists).
o $remote_file
- The remote file path.
o $mode
- The transfer mode. Must be either FTP_ASCII or FTP_BINARY.
o $resumepos
- 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(3) example
<?php
// define some variables
$local_file = 'local.zip';
$server_file = 'server.zip';
// set up basic connection
$conn_id = ftp_connect($ftp_server);
// login with username and password
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
// try to download $server_file and save to $local_file
if (ftp_get($conn_id, $local_file, $server_file, FTP_BINARY)) {
echo "Successfully written to $local_file
";
} else {
echo "There was a problem
";
}
// close the connection
ftp_close($conn_id);
?>
SEE ALSO
ftp_pasv(3), ftp_fget(3), ftp_nb_get(3), ftp_nb_fget(3).
PHP Documentation Group FTP_GET(3)
