【PHP8.x】CURLINFO_FTP_ENTRY_PATH定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたURLにHTTPリクエストを送信し、HTTPステータスコードを取得する関数。
5 * システムエンジニアを目指す初心者向けに、cURLの基本的な使い方と
6 * HTTPステータスコードの取得方法を示します。
7 *
8 * @param string $url リクエストを送信するURL
9 * @return void
10 */
11function getHttpStatusCode(string $url): void
12{
13    // cURLセッションを初期化します。
14    $ch = curl_init();
15
16    // cURLオプションを設定します。
17    // リクエスト対象のURLを設定します。
18    curl_setopt($ch, CURLOPT_URL, $url);
19    // curl_exec()の戻り値を文字列として取得し、ブラウザに直接出力されないようにします。
20    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
21    // リダイレクトが検出された場合に、自動的に追跡するように設定します。
22    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
23    // HTTPSサイトの場合、SSL証明書の検証を行います。
24    // 開発環境などでは一時的に false にすることもありますが、本番環境では true にすることを強く推奨します。
25    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
26    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2); // 2は一般的な推奨値です。
27
28    // cURLセッションを実行し、レスポンスを取得します。
29    $response = curl_exec($ch);
30
31    // cURLの実行中にエラーが発生したかチェックします。
32    if (curl_errno($ch)) {
33        // エラーメッセージを表示します。
34        echo "cURLエラーが発生しました: " . curl_error($ch) . PHP_EOL;
35    } else {
36        // HTTPステータスコードを取得します。
37        // CURLINFO_HTTP_CODEは、最後に受け取ったHTTPステータスコードを取得するための定数です。
38        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
39
40        echo "URL: " . $url . PHP_EOL;
41        echo "HTTPステータスコード: " . $httpCode . PHP_EOL;
42
43        // HTTPステータスコードに基づいて簡単なメッセージを表示します。
44        if ($httpCode >= 200 && $httpCode < 300) {
45            echo "ステータス: 成功 (OK)" . PHP_EOL;
46        } elseif ($httpCode >= 300 && $httpCode < 400) {
47            echo "ステータス: リダイレクト" . PHP_EOL;
48        } elseif ($httpCode >= 400 && $httpCode < 500) {
49            echo "ステータス: クライアントエラー (例: 404 Not Found)" . PHP_EOL;
50        } elseif ($httpCode >= 500 && $httpCode < 600) {
51            echo "ステータス: サーバーエラー" . PHP_EOL;
52        } else {
53            echo "ステータス: 不明なコード" . PHP_EOL;
54        }
55    }
56
57    // cURLセッションを終了し、リソースを解放します。
58    curl_close($ch);
59}
60
61// --- サンプル使用例 ---
62
63echo "--- GoogleのHTTPステータスコード取得 ---" . PHP_EOL;
64getHttpStatusCode("https://www.google.com");
65echo PHP_EOL;
66
67echo "--- 存在しないページのHTTPステータスコード取得 (例: 404 Not Found) ---" . PHP_EOL;
68getHttpStatusCode("https://www.google.com/nonexistent-page-12345");
69echo PHP_EOL;
70
71echo "--- GitHubのHTTPステータスコード取得 ---" . PHP_EOL;
72getHttpStatusCode("https://github.com");
73echo PHP_EOL;
74
75// 注釈:
76// このコードでは、リファレンス情報で与えられた定数 `CURLINFO_FTP_ENTRY_PATH` ではなく、
77// キーワードに強く関連する `CURLINFO_HTTP_CODE` を使用しています。
78// `CURLINFO_FTP_ENTRY_PATH` はFTP通信で転送後のエントリパスを取得する際に利用される定数です。

このPHPサンプルコードは、システムエンジニアを目指す初心者向けに、cURL拡張機能を用いて指定されたURLのHTTPステータスコードを取得する基本的な方法を示しています。

getHttpStatusCode関数は、HTTPリクエストを送信するURLを文字列型の$urlとして引数に取ります。この関数はvoidを戻り値としており、処理結果は画面に直接出力されます。

処理はcurl_init()でcURLセッションを初期化するところから始まります。次にcurl_setopt()を用いて、リクエスト先のURL設定（CURLOPT_URL）や、レスポンスを文字列として取得する設定（CURLOPT_RETURNTRANSFER）など、様々な通信オプションを設定します。curl_exec()で実際にHTTPリクエストを実行し、ウェブサーバーからの応答を取得します。

リクエスト中にエラーが発生しなかった場合、curl_getinfo()関数と定数CURLINFO_HTTP_CODEを使って、最後に受信したHTTPステータスコード（例：200 OK, 404 Not Foundなど）を取得します。この定数は、HTTP通信の成否や種類を判断するための重要な情報です。取得したステータスコードは、その意味合いとともに画面に表示され、通信の状態を分かりやすく伝えます。最後にcurl_close()でcURLセッションを終了し、使用したリソースを解放します。

なお、提供されたリファレンス情報にあるCURLINFO_FTP_ENTRY_PATHはFTP通信で転送後のエントリパスを取得する際に利用される定数であり、このHTTP通信のサンプルコードでは、HTTPステータスコード取得用のCURLINFO_HTTP_CODEが使われています。

Copy
1<?php
2
3/**
4 * cURLを使用してFTPサーバーに接続し、
5 * FTPのパス情報とレスポンスコードを取得するサンプルコードです。
6 *
7 * PHPのCURL拡張機能は、さまざまなプロトコル（HTTP, HTTPS, FTPなど）を介した
8 * データ転送を可能にします。
9 *
10 * - CURLINFO_FTP_ENTRY_PATH:
11 *   これは `curl_getinfo()` 関数と組み合わせて使用される定数です。
12 *   FTPサーバー上の最終リダイレクトまたは現在のディレクトリへのパス（例: '/upload/') を返します。
13 *   FTP LISTまたはNLSTコマンドが実行され、パス情報が利用可能な場合にのみ取得できます。
14 *
15 * - CURLINFO_RESPONSE_CODE:
16 *   これも `curl_getinfo()` 関数と組み合わせて使用される定数です。
17 *   HTTPリクエストの場合はHTTPステータスコード（例: 200, 404）を返しますが、
18 *   FTPリクエストの場合は通常、0 または FTP固有の成功/失敗を示す値が返されます。
19 *
20 * この例では、匿名FTPサーバーの公開ディレクトリに接続を試みます。
21 * 実際の運用環境で特定のFTPサーバーに接続する場合は、適切な認証情報が必要です。
22 */
23function getCurlFtpAndResponseInfo(): void
24{
25    // 接続を試みるFTPサーバーのURLを指定します。
26    // ディレクトリを指定することで、CURLINFO_FTP_ENTRY_PATH が
27    // 現在のディレクトリを示すパスを返すことを期待します。
28    // アクセスできない場合は、ご自身の利用可能な匿名FTPサーバーURLなどに変更してください。
29    // 例: ftp://speedtest.tele2.net/upload/
30    $ftpUrl = 'ftp://speedtest.tele2.net/upload/';
31
32    // cURLセッションを初期化します。
33    // これから行うネットワーク通信の準備をします。
34    $ch = curl_init();
35
36    // cURLオプションを設定します。
37    // 各オプションは通信の挙動を細かく制御します。
38    // アクセスするURLを設定
39    curl_setopt($ch, CURLOPT_URL, $ftpUrl);
40    // curl_exec() の結果を直接出力せず、文字列として返すように設定
41    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
42    // FTP接続の場合、ユーザー名とパスワードが必要です。
43    // 匿名FTPの場合は、ユーザー名 'anonymous' と任意のメールアドレスを使用します。
44    curl_setopt($ch, CURLOPT_USERPWD, 'anonymous:dummy@example.com');
45    // FTPサーバーのディレクトリリストのみを取得するように指示します（FTPのLISTコマンドに相当）。
46    curl_setopt($ch, CURLOPT_FTPLISTONLY, true);
47    // レスポンスヘッダーを含めないように設定
48    curl_setopt($ch, CURLOPT_HEADER, false);
49
50    echo "FTPサーバーへの接続を試行中... ({$ftpUrl})\n\n";
51
52    // cURLセッションを実行し、サーバーからのレスポンスを取得します。
53    $response = curl_exec($ch);
54
55    // cURL実行中にエラーが発生したかを確認します。
56    if (curl_errno($ch)) {
57        echo 'cURL エラーが発生しました: ' . curl_error($ch) . "\n";
58    } else {
59        // cURLセッションから各種情報を取得します。
60        // CURLINFO_FTP_ENTRY_PATH でFTPのディレクトリパスを取得
61        $ftpEntryPath = curl_getinfo($ch, CURLINFO_FTP_ENTRY_PATH);
62        // CURLINFO_RESPONSE_CODE でレスポンスコードを取得
63        $responseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
64        // 実際にアクセスされたURLを取得
65        $effectiveUrl = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
66
67        echo "cURL実行結果:\n";
68        echo "-----------------------------------------------------\n";
69        echo "最終的にアクセスしたURL (CURLINFO_EFFECTIVE_URL): {$effectiveUrl}\n";
70        // CURLINFO_FTP_ENTRY_PATH は利用可能な場合のみ値を返します。
71        echo "FTPエントリパス (CURLINFO_FTP_ENTRY_PATH): " . ($ftpEntryPath !== null && $ftpEntryPath !== '' ? $ftpEntryPath : 'N/A または取得不可') . "\n";
72        echo "レスポンスコード (CURLINFO_RESPONSE_CODE): {$responseCode}\n";
73        echo "-----------------------------------------------------\n";
74
75        // 取得したディレクトリリストの内容を表示します。
76        if (!empty($response)) {
77            echo "\n取得したディレクトリリスト:\n";
78            echo $response;
79        } else {
80            echo "\nディレクトリリストは取得されませんでした。\n";
81        }
82    }
83
84    // cURLセッションを閉じ、リソースを解放します。
85    curl_close($ch);
86}
87
88// 定義した関数を実行し、FTP情報を取得・表示します。
89getCurlFtpAndResponseInfo();

このサンプルコードは、PHPのcURL拡張機能を用いてFTPサーバーに接続し、その通信に関するパス情報やレスポンスコードを取得する方法を示しています。cURLはHTTPやFTPなど様々なプロトコルでのデータ転送を可能にする強力な機能です。

まず、curl_init()でcURLセッションを開始し、curl_setopt()で接続先のFTP URL、認証情報、FTPのリスト取得など、通信の詳細な設定を行います。設定後、curl_exec()で実際にFTPサーバーとの通信を実行します。通信が完了すると、curl_getinfo()関数を使用して通信結果に関する様々な情報を取得できます。

CURLINFO_FTP_ENTRY_PATHは、このcurl_getinfo()関数の引数として使用される定数です。FTPサーバー上で最終的にアクセスしたディレクトリのパスを文字列として返します。この情報は、FTP LISTやNLSTコマンドが実行され、パスが利用可能な場合に取得できます。一方、CURLINFO_RESPONSE_CODEもcurl_getinfo()で利用する定数で、通信のレスポンスコードを整数として返します。HTTP通信ではHTTPステータスコードを返しますが、FTP通信の場合は通常0またはFTP固有の成功・失敗を示す値が返されます。

サンプルコードでは、匿名FTPサーバーへの接続を試み、エラーが発生しなかった場合にこれらの情報を取得・表示しています。最後にcurl_close()でセッションを終了し、利用したリソースを解放します。これにより、ネットワーク通信と情報取得の基本を理解することができます。