PHPのftp_get_option()関数とは？使い方とサンプルコードを徹底解説

PHPのftp_get_option()関数は、FTP接続における各種ランタイムオプション（実行時設定）の現在値を取得するための関数です。たとえば、ネットワーク操作に使用されるタイムアウト秒数や、オートシーク機能が有効になっているかどうかなどを確認できます。

基本構文

ftp_get_option(con, option);

パラメータ

• con：対象となるFTP接続リソース（ftp_connect()で取得したもの）を指定します。

• option：取得したいランタイムオプションを指定します。指定できる値は以下の通りです。

  • FTP_TIMEOUT_SEC — ネットワーク操作に使用されるタイムアウト時間（秒）を返します。

  • FTP_AUTOSEEK — このオプションが有効な場合はTRUE、無効な場合はFALSEを返します。

戻り値

ftp_get_option()関数は、成功した場合にそのオプションの値を返します。指定されたオプションがサポートされていない場合は、FALSEを返します。

使用例

以下は、FTPサーバーに接続し、タイムアウト設定を取得して表示するサンプルコードです。

<?php
   $ftp_server="192.168.0.4";
   $ftp_user="amit";
   $ftp_pass="tywg61gh";
   $con = ftp_connect($ftp_server) or die("Could not connect to $ftp_server");
   $login = ftp_login($con, $ftp_user, $ftp_pass);
   echo ftp_get_option($con, FTP_TIMEOUT_SEC);
   ftp_close($con);
?>

コードのポイント

• まずftp_connect()でFTPサーバーに接続し、失敗した場合はdie()で処理を終了させます。

• ftp_login()でユーザー名とパスワードを使って認証を行います。

• ftp_get_option()に「FTP_TIMEOUT_SEC」を渡すことで、現在のタイムアウト秒数を出力します。

• 最後にftp_close()で接続を閉じ、リソースを解放します。

このように、ftp_get_option()関数を活用すれば、FTP接続の動作設定を簡単に確認でき、デバッグや接続パラメータのチューニングにも役立ちます。