ftp_nb_put

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

ftp_nb_putFTP サーバーにファイルを保存する(非ブロッキング)

説明

ftp_nb_put(
    FTP\Connection $ftp,
    string $remote_filename,
    string $local_filename,
    int $mode = FTP_BINARY,
    int $offset = 0
): int|false

ftp_nb_put() はローカルファイルを FTP サーバーに保存します。

ftp_put() との違いは、この関数が 非同期処理でファイルをアップロードするということです。そのため、 ファイルをアップロードしている最中に別の処理を行うことができます。

パラメータ

ftp

FTP\Connection クラスのインスタンス

remote_filename

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

local_filename

ローカルファイルのパス。

mode

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

offset

リモートファイル内での、アップロード開始位置。

戻り値

FTP_FAILEDFTP_FINISHED あるいは FTP_MOREDATA を返します。 ローカルファイルのオープンに失敗した場合、false を返します。

変更履歴

バージョン 説明
8.1.0 引数 ftp は、FTP\Connection のインスタンスを期待するようになりました。 これより前のバージョンでは、リソース を期待していました。
7.3.0 mode パラメータはオプションになりました。 これより前のバージョンでは、このパラメータは必須でした。

例1 ftp_nb_put() の例

<?php

// アップロードを開始する
$ret ftp_nb_put($ftp"test.remote""test.local"FTP_BINARY);
while (
$ret == FTP_MOREDATA) {
   
   
// 何かお好みの動作を
   
echo ".";

   
// アップロードを継続する…
   
$ret ftp_nb_continue($ftp);
}
if (
$ret != FTP_FINISHED) {
   echo 
"There was an error uploading the file...";
   exit(
1);
}
?>

例2 ftp_nb_put() でアップロードを再開する

<?php

// 開始
$ret ftp_nb_put($ftp"test.remote""test.local"
                      
FTP_BINARYftp_size("test.remote"));
// あるいは: $ret = ftp_nb_put($my_connection, "test.remote", "test.local", 
//                             FTP_BINARY, FTP_AUTORESUME);

while ($ret == FTP_MOREDATA) {
   
   
// 何かお好みの動作を
   
echo ".";

   
// アップロードを継続する…
   
$ret ftp_nb_continue($ftp);
}
if (
$ret != FTP_FINISHED) {
   echo 
"There was an error uploading the file...";
   exit(
1);
}
?>

参考

  • ftp_nb_fput() - オープン中のファイルを FTP サーバーに保存する(非ブロッキング)
  • ftp_nb_continue() - ファイルの取得/送信を継続する(非ブロッキング)
  • ftp_put() - FTP サーバーにファイルをアップロードする
  • ftp_fput() - オープン中のファイルを FTP サーバーにアップロードする

関連キーワード:  サーバー, 保存, ブロッキング, put, ファイル, filename, オープン, パラメータ, mode, int