PHP 5.4.31 Released

ftp_fget

(PHP 4, PHP 5)

ftp_fgetFTP サーバーからファイルをダウンロードし、オープン中のファイルに保存する

説明

bool ftp_fget ( resource $ftp_stream , resource $handle , string $remote_file , int $mode [, int $resumepos = 0 ] )

ftp_fget() は、FTP サーバーから remote_file を取得し、指定したファイルポインタ fp に書きこみます。

パラメータ

ftp_stream

FTP 接続のリンク ID 。

handle

オープンされているファイルのポインタ。ここにデータが保存されます。

remote_file

リモートファイルのパス。

mode

転送モード。FTP_ASCII または FTP_BINARY のどちらかを指定する必要があります。

resumepos

リモートファイル中で、ダウンロードを開始する位置。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例1 ftp_fget() の例

<?php

// リモートファイルへのパス。
$remote_file 'somefile.txt';
$local_file 'localfile.txt';

// 書き込み用のファイルをオープンします。
$handle fopen($local_file'w');

// 接続を確立します。
$conn_id ftp_connect($ftp_server);

// ユーザー名とパスワードを指定してログインします。
$login_result ftp_login($conn_id$ftp_user_name$ftp_user_pass);

// $remote_file をダウンロードし、$handle に保存しようとします。
if (ftp_fget($conn_id$handle$remote_fileFTP_ASCII0)) {
 echo 
"$local_file への書き込みに成功しました\n";
} else {
 echo 
"$remote_file を $local_file にダウンロードする際に問題が発生しました\n";
}

// 接続およびファイルハンドラを閉じます。
ftp_close($conn_id);
fclose($handle);
?>

変更履歴

バージョン 説明
4.3.0 resumepos が追加されました。

参考

  • ftp_get() - FTP サーバーからファイルをダウンロードする
  • ftp_nb_get() - FTP サーバーからファイルを取得し、ローカルファイルに書き込む(非ブロッキング)
  • ftp_nb_fget() - FTP サーバーからファイルをダウンロードし、オープン中のファイルに保存する(非ブロッキング)

add a note add a note

User Contributed Notes 5 notes

up
1
rodrigo-rocha at oi dot net dot br
11 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.
up
0
mike at eastghost dot com
1 year 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.
up
0
broom at alturnanetworks dot com
5 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']);
}
?>
up
-1
justrafi at gmail dot com
6 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;
}
up
-1
broom at alturnanetworks dot com
5 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;
    }
}
?>
To Top