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

Copy
1<?php
2
3/**
4 * 指定されたURLに対してcURLリクエストを実行し、
5 * その通信に使用されたローカルIPアドレスを取得して表示します。
6 *
7 * CURLINFO_LOCAL_IP は、curl_getinfo() 関数で取得する情報の一つで、
8 * cURLが接続を確立したローカル側のIPアドレスを指す定数です。
9 *
10 * @param string $url リクエストを送信するターゲットURL。
11 * @return void
12 */
13function displayLocalIpInfoForCurlRequest(string $url): void
14{
15    // cURLセッションを初期化します。
16    // $ch (cURLハンドル) は、この後のcURL操作でセッションを識別するために使われます。
17    $ch = curl_init();
18
19    // cURLセッションの初期化に失敗した場合のエラーハンドリング。
20    if ($ch === false) {
21        echo "エラー: cURLセッションの初期化に失敗しました。\n";
22        return;
23    }
24
25    // cURLオプションを設定します。
26    // CURLOPT_URL: リクエストを送信するターゲットURLを指定します。
27    curl_setopt($ch, CURLOPT_URL, $url);
28    // CURLOPT_RETURNTRANSFER: curl_exec() が結果を文字列として返すように設定します。
29    // これを設定しない場合、結果は直接出力されます。
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
31    // CURLOPT_HEADER: レスポンスのヘッダー情報を含めるかどうかを設定します (falseで含めない)。
32    curl_setopt($ch, CURLOPT_HEADER, false);
33
34    // cURLセッションを実行し、指定されたURLにリクエストを送信します。
35    $response = curl_exec($ch);
36
37    // cURL実行中にエラーが発生したか確認します。
38    if (curl_errno($ch)) {
39        echo "エラー: cURLリクエストの実行中に問題が発生しました: " . curl_error($ch) . "\n";
40    } else {
41        // cURLセッションの実行が成功した場合、追加情報を取得します。
42        // CURLINFO_LOCAL_IP 定数を使用して、このcURL通信に使用されたローカルIPアドレスを取得します。
43        $localIp = curl_getinfo($ch, CURLINFO_LOCAL_IP);
44
45        if ($localIp) {
46            echo "ターゲットURL: " . $url . "\n";
47            echo "このcURL通信に使用されたローカルIPアドレス: " . $localIp . "\n";
48        } else {
49            echo "ローカルIPアドレスの取得に失敗しました。接続が行われなかったか、情報が利用できません。\n";
50        }
51    }
52
53    // 処理が完了したら、cURLセッションを閉じます。
54    // これにより、関連するリソースが解放されます。
55    curl_close($ch);
56}
57
58// サンプルとして使用するWebサイトのURLを指定します。
59// 実際には、任意の有効なURLを使用できます。
60$targetUrl = "http://example.com";
61
62// 関数を呼び出して、cURL通信のローカルIPアドレス情報を表示します。
63displayLocalIpInfoForCurlRequest($targetUrl);
64
65?>

このサンプルコードは、PHPのcURL拡張機能を利用して、特定のURLへHTTPリクエストを送信する際に、自分のサーバー側（ローカル側）が使用したIPアドレスを取得し、表示する方法を解説しています。CURLINFO_LOCAL_IPは、curl_getinfo()関数で取得できる情報の一つであり、cURLが接続を確立したローカルIPアドレスを示す定数です。

コードではまずcurl_init()でcURLセッションを初期化し、curl_setopt()でターゲットURLやレスポンスを文字列として取得する設定などを行います。その後、curl_exec()でリクエストを実行し、通信に成功した場合はcurl_getinfo()関数にCURLINFO_LOCAL_IPを渡すことで、実際に通信に利用されたローカルIPアドレスを取得します。取得したIPアドレスは画面に出力され、最終的にcurl_close()でcURLセッションを閉じ、関連するリソースを解放します。

サンプルコード内のdisplayLocalIpInfoForCurlRequest関数は、引数としてリクエスト先のURL（string $url）を受け取ります。この関数は情報表示を行うため、特定の値を返すことはなく、戻り値はvoidです。このコードを実行することで、例えばWebサーバーから外部サービスへ接続する際に、どのIPアドレスが使われたかを確認することができます。

Copy
1<?php
2
3/**
4 * 指定されたURLからcURL情報を取得し、HTTP応答コードとローカルIPアドレスを表示します。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * PHPのcURL拡張機能とcurl_getinfo()関数の基本的な使い方を示します。
8 *
9 * @param string $url 情報を取得する対象のURL。
10 * @return void
11 */
12function getAndDisplayCurlInfo(string $url): void
13{
14    // 1. cURLセッションを初期化します。
15    //    これはHTTPリクエストを行うための準備です。
16    $ch = curl_init();
17
18    // cURLセッションが正常に初期化されたか確認します。
19    if ($ch === false) {
20        echo "エラー: cURLセッションの初期化に失敗しました。\n";
21        return;
22    }
23
24    // 2. cURLオプションを設定します。
25    //    - CURLOPT_URL: リクエストを送信するURLを指定します。
26    //    - CURLOPT_RETURNTRANSFER: curl_exec()が結果を直接出力するのではなく、
27    //      文字列として返すようにします。
28    curl_setopt($ch, CURLOPT_URL, $url);
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30
31    // 3. cURLセッションを実行し、HTTPリクエストを送信します。
32    $response = curl_exec($ch);
33
34    // 4. cURL実行中にエラーが発生したか確認します。
35    if (curl_errno($ch)) {
36        echo "cURLエラー (" . curl_errno($ch) . "): " . curl_error($ch) . "\n";
37        // エラーが発生した場合は、セッションを閉じて終了します。
38        curl_close($ch);
39        return;
40    }
41
42    // 5. curl_getinfo() を使用して、cURLセッションに関する情報を取得します。
43
44    // HTTP応答コードを取得します。
45    // (キーワード "curlinfo_response_code" に関連)
46    // 例: 200 (成功), 404 (見つからない), 500 (サーバーエラー) など。
47    // PHP 8.2以降では CURLINFO_RESPONSE_CODE も同じ目的で使用できますが、
48    // PHP 8.0/8.1 では CURLINFO_HTTP_CODE が推奨されます。
49    $httpResponseCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
50    echo "URL: " . $url . "\n";
51    echo "HTTP応答コード: " . $httpResponseCode . "\n";
52
53    // リクエストを送信したローカルIPアドレスを取得します。(リファレンス情報に関連)
54    // これは、サーバーが複数のネットワークインターフェースを持つ場合に、
55    // どのIPアドレスを使用してリクエストを送信したかを示します。
56    $localIpAddress = curl_getinfo($ch, CURLINFO_LOCAL_IP);
57    echo "ローカルIPアドレス: " . $localIpAddress . "\n";
58
59    // 6. cURLセッションを閉じます。
60    //    リソースを解放するために非常に重要です。
61    curl_close($ch);
62}
63
64// サンプル使用例:
65// 動作確認のため、アクセス可能なURLを指定してください。
66// インターネット接続が必要です。
67getAndDisplayCurlInfo("https://www.example.com");
68
69?>

このサンプルコードは、PHPのcURL拡張機能を利用して指定されたURLにHTTPリクエストを送信し、その結果からHTTP応答コードとリクエスト送信元のローカルIPアドレスを取得・表示する手順を示しています。

まず、curl_init()でcURLセッションを初期化し、curl_setopt()でリクエスト対象のURLと、curl_exec()が結果を文字列として返すようにするオプションを設定します。次に、curl_exec()で実際にHTTPリクエストを実行し、応答を取得します。リクエスト中にエラーが発生した場合は、curl_errno()やcurl_error()で詳細を確認し、処理を適切に終了させます。

リクエストが成功した後、curl_getinfo()関数を使用してcURLセッションに関する詳細情報を取得します。この関数にCURLINFO_HTTP_CODEを渡すと、WebサーバーからのHTTP応答コード（例: 200 OK、404 Not Foundなど）が得られます。また、CURLINFO_LOCAL_IPを渡すことで、リクエストを送信したプログラム実行環境のローカルIPアドレスを取得できます。これは、どのネットワークインターフェース経由で通信が行われたかを確認する際に役立ちます。最後に、curl_close()でcURLセッションを閉じ、使用したリソースを解放することが重要です。

getAndDisplayCurlInfo関数は、情報を取得したいURLを文字列型の引数$urlとして受け取ります。取得した情報は関数内で直接画面に出力するため、戻り値はvoid（何も返さない）です。このコードは、外部リソースへの接続やネットワーク情報の取得に関するPHPの基本を学ぶ初心者にとって有用です。