PHPのftp_nb_get()関数の使い方を徹底解説

はじめに

ftp_nb_get() 関数は、FTPサーバーからファイルをダウンロードするためのPHP関数です。ftp_get() の非同期（ノンブロッキング）版にあたり、ダウンロードの進行中でもスクリプト内の他の処理を並行して実行できるのが大きな特徴です。大きなファイルを扱う場合や、ダウンロード中にユーザーへ進捗状況を表示したい場合などに便利です。

構文

ftp_nb_get(con, local_file, server_file, transfer_mode, beg_pos);

パラメータ

• con − ftp_connect() で取得したFTP接続リソースを指定します。

• local_file − ダウンロードしたデータを保存するローカルファイルのパスを指定します。

• server_file − ダウンロード対象となるサーバー上のファイルパスを指定します。

• transfer_mode − 転送モードを指定します。指定できる値は次のいずれかです。

  - FTP_ASCII（アスキーモード：テキストファイル向け）

  - FTP_BINARY（バイナリモード：画像や実行ファイルなど向け）

• beg_pos − ダウンロードを開始するファイル内の位置（オフセット）を指定します。省略可能で、中断したダウンロードの再開などに利用されます。

戻り値

ftp_nb_get() 関数は、処理状態を示す以下のいずれかの値を返します。

• FTP_FAILED − 送受信に失敗したことを示します。

• FTP_FINISHED − 送受信が完了したことを示します。

• FTP_MOREDATA − 送受信が現在進行中であることを示します。

使用例

以下は、ftp_nb_get() 関数を使ってサーバー上のファイルを非同期にダウンロードする例です。

<?php
&nbsp;&nbsp;&nbsp;&nbsp;$ftp_server = "192.168.0.4";
&nbsp;&nbsp;&nbsp;&nbsp;$ftp_user = "jacob";
&nbsp;&nbsp;&nbsp;&nbsp;$ftp_pass = "tywg61gh";

&nbsp;&nbsp;&nbsp;&nbsp;// FTPサーバーに接続
&nbsp;&nbsp;&nbsp;&nbsp;$con = ftp_connect($ftp_server) or die("$ftp_server に接続できませんでした");
&nbsp;&nbsp;&nbsp;&nbsp;$login = ftp_login($con, $ftp_user, $ftp_pass);

&nbsp;&nbsp;&nbsp;&nbsp;$my_serverfile = "demo.txt";
&nbsp;&nbsp;&nbsp;&nbsp;$local_file = "new.txt";

&nbsp;&nbsp;&nbsp;&nbsp;// 非同期ダウンロードを開始
&nbsp;&nbsp;&nbsp;&nbsp;$c = ftp_nb_get($con, $local_file, $my_serverfile, FTP_ASCII);

&nbsp;&nbsp;&nbsp;&nbsp;// ダウンロードが完了するまで継続
&nbsp;&nbsp;&nbsp;&nbsp;while ($c == FTP_MOREDATA){
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// ダウンロードを続行
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;$c = ftp_nb_continue($con);
&nbsp;&nbsp;&nbsp;&nbsp;}

&nbsp;&nbsp;&nbsp;&nbsp;if ($c != FTP_FINISHED) {
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo "サーバーファイルのダウンロード中にエラーが発生しました！";
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;exit(1);
&nbsp;&nbsp;&nbsp;&nbsp;}

&nbsp;&nbsp;&nbsp;&nbsp;// 接続を閉じる
&nbsp;&nbsp;&nbsp;&nbsp;ftp_close($con);
?>

コードの解説

まず ftp_connect() と ftp_login() でFTPサーバーへの接続と認証を行います。その後、ftp_nb_get() を呼び出して非同期ダウンロードを開始し、戻り値が FTP_MOREDATA である間は ftp_nb_continue() を繰り返し呼び出すことでダウンロードを進めます。この仕組みにより、ループの中に他の処理を挟むことができ、進捗表示やログ出力などを並行して行えます。最後に戻り値が FTP_FINISHED かどうかを確認し、失敗していればエラーメッセージを表示して終了します。

まとめ

ftp_nb_get() 関数は、FTPサーバーからのファイルダウンロードをノンブロッキングで実行できる強力な関数です。戻り値の状態（FTP_FAILED / FTP_FINISHED / FTP_MOREDATA）を適切に判定しながら ftp_nb_continue() と組み合わせて使うことで、応答性の高いアプリケーションを構築できます。