ftp_fget
(PHP 4, PHP 5, PHP 7, PHP 8)
ftp_fget — FTP サーバーからファイルをダウンロードし、オープン中のファイルに保存する
説明
ftp_fget(
FTP\Connection
resource
string
int
int
): bool
FTP\Connection
$ftp
,resource
$stream
,string
$remote_filename
,int
$mode
= FTP_BINARY
,int
$offset
= 0): bool
ftp_fget() は、FTP サーバーから
remote_filename
を取得し、指定したファイルポインタに書きこみます。
パラメータ
ftp
-
FTP\Connection クラスのインスタンス
stream
-
オープンされているファイルのポインタ。ここにデータが保存されます。
remote_filename
-
リモートファイルのパス。
mode
-
転送モード。
FTP_ASCII
またはFTP_BINARY
のどちらかを指定する必要があります。 offset
-
リモートファイル中で、ダウンロードを開始する位置。
変更履歴
バージョン | 説明 |
---|---|
8.1.0 |
引数 ftp は、FTP\Connection
のインスタンスを期待するようになりました。
これより前のバージョンでは、リソース を期待していました。
|
7.3.0 |
mode パラメータはオプションになりました。
これより前のバージョンでは、このパラメータは必須でした。
|
例
例1 ftp_fget() の例
<?php
// リモートファイルへのパス。
$remote_file = 'somefile.txt';
$local_file = 'localfile.txt';
// 書き込み用のファイルをオープンします。
$handle = fopen($local_file, 'w');
// 接続を確立します。
$ftp = ftp_connect($ftp_server);
// ユーザー名とパスワードを指定してログインします。
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);
// $remote_file をダウンロードし、$handle に保存しようとします。
if (ftp_fget($ftp, $handle, $remote_file, FTP_ASCII, 0)) {
echo "successfully written to $local_file\n";
} else {
echo "There was a problem while downloading $remote_file to $local_file\n";
}
// 接続およびファイルハンドラを閉じます。
ftp_close($ftp);
fclose($handle);
?>
参考
- ftp_get() - FTP サーバーからファイルをダウンロードする
- ftp_nb_get() - FTP サーバーからファイルを取得し、ローカルファイルに書き込む(非ブロッキング)
- ftp_nb_fget() - FTP サーバーからファイルをダウンロードし、オープン中のファイルに保存する(非ブロッキング)
+add a note
User Contributed Notes 6 notes
broom at alturnanetworks dot com ¶
16 years ago
Another ftp_get_contents approach, using a temperary stream handler. Returns file contents as string.
<?php
function ftp_get_contents ($conn_id, $filename,
//Create temp handler:
$tempHandle = fopen('php://temp', 'r+');
//Get file from FTP assuming that it exists:
ftp_fget($conn_id, $tempHandle, $filename, FTP_ASCII, 0));
//Getting detailed stats to check filesize:
$fstats = fstat($tempHandle);
return fread($tempHandle, $fstats['size']);
}
?>
broom at alturnanetworks dot com ¶
16 years ago
<?php
/**
* Function returns contents via FTP connection and returns it as string (right version...)
*/
function ftp_get_contents ($conn_id, $filename) {
//Create temp handler:
$tempHandle = fopen('php://temp', 'r+');
//Get file from FTP:
if (@ftp_fget($conn_id, $tempHandle, $filename, FTP_ASCII, 0)) {
rewind($tempHandle);
return stream_get_contents($tempHandle);
} else {
return false;
}
}
?>
mike at eastghost dot com ¶
11 years ago
You might need to use ftp_pasv() if you're behind a firewall and receiving odd timeouts, file creation but now local data saving, etc.
lionskape at gmail dot com ¶
7 years ago
if you are using windows ftp-server with cp1251 encoding there are some troubles with russian "я" in filename\path.
php use telnet to connect ftp-server and there are special symbol with code 255 in telnet protocol. You can try use ftp_raw($connection, 'OPTS UTF8 ON'); and work in utf-8 (if server provides it).
P.S. sorry for my bad english
justrafi at gmail dot com ¶
16 years ago
I was in need to synchronize two folders on two separate servers, one is a Windows server, and the other is a Linux server. I created this short and sweet function to help me do this. PLEASE NOTICE: This will not copy folders, and probably will fail if remote folder contains anything else than files.
function sync_folders($host, $port, $username, $password, $remote_dir, $local_dir, $passive_mode = true) {
$conn_id = ftp_connect($host, $port);
if (!$conn_id) return false; # fail to connect
if (!ftp_login($conn_id, $username, $password)) { ftp_close($conn_id); return false; } # fail to login
ftp_pasv($conn_id, $passive_mode);
if (!ftp_chdir($conn_id, $remote_dir)) { ftp_close($conn_id); return false; } # fail to change dir
if (substr($local_dir, -1) != '/') $local_dir .= '/';
$list = ftp_nlist($conn_id, '.');
sort($list);
foreach ($list as $file) {
if (!file_exists($local_dir . $file)) {
$is_copied = ftp_get($conn_id, $local_dir . $file, $file, FTP_BINARY);
}
}
ftp_close($conn_id);
return true;
}
rodrigo-rocha at oi dot net dot br ¶
22 years ago
If you suply only a filename to the second parameter of function the ftp_get will open a pointer to the local file creating it and write to it.It's ok if your server dont execute for to mutch time and you dont get too many files but if you do it too many times the pointers created by ftp_get will not be closed and will end your opened files capacity at your server making it to do not open any more files until you restart it.