ftp_set_option

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

ftp_set_option — さまざまな FTP 実行時オプションを設定する

説明

ftp_set_option(FTP\Connection $ftp, int $option, int|bool $value): true

この関数は、指定した FTP 接続に関してのさまざまな実行時オプションを制御します。

パラメータ

ftp

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

option

現在、以下のオプションがサポートされています:
サポートされる実行時 FTP オプション

FTP_TIMEOUT_SEC 全てのネットワーク関連関数に関して秒単位でタイムアウトを変更します。valueは、 0 より大きい整数値である必要があります。デフォルトのタイムアウトは90秒です。

FTP_AUTOSEEK 有効になっている場合は、GET や PUT のリクエストが resumepos や startpos のパラメータ付きで実行されるとファイル中の該当位置をシークします。デフォルトで有効になっています。

FTP_USEPASVADDRESS このオプションを無効にすると、PHP は PASV コマンドからのレスポンスとして FTPサーバーから返されたIPアドレスを無視します。代わりに、ftp_connect() で与えられた IPアドレスを使います。 value は、bool でなければなりません。

value

**サポートされる実行時 FTP オプション**
`FTP_TIMEOUT_SEC`	全てのネットワーク関連関数に関して秒単位でタイムアウトを変更します。`value`は、 0 より大きい整数値である必要があります。デフォルトのタイムアウトは90秒です。
`FTP_AUTOSEEK`	有効になっている場合は、GET や PUT のリクエストが `resumepos` や `startpos` のパラメータ付きで実行されるとファイル中の該当位置をシークします。デフォルトで有効になっています。
`FTP_USEPASVADDRESS`	このオプションを無効にすると、PHP は PASV コマンドからのレスポンスとして FTPサーバーから返されたIPアドレスを無視します。代わりに、ftp_connect() で与えられた IPアドレスを使います。 `value` は、bool でなければなりません。

このパラメータの内容は、どの option を変更しようとしているかによって変わります。

戻り値

常に true を返します。

エラー / 例外

option がサポートされていない場合、 ValueError がスローされます。渡された value が指定された option に対して期待される型と一致しない場合、 TypeError がスローされます。

変更履歴

バージョン	説明
8.5.0	戻り値の型が、`true` になりました。これより前のバージョンでは、bool でした。
8.1.0	引数 `ftp` は、FTP\Connection のインスタンスを期待するようになりました。これより前のバージョンでは、resource を期待していました。

例

例1 ftp_set_option() の例

<?php
// ネットワークのタイムアウトを 10 秒に設定する
ftp_set_option($ftp, FTP_TIMEOUT_SEC, 10);
?>

参考

ftp_get_option() - カレントの FTP 接続での種々の実行時動作を取得する