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

Copy
1<?php
2
3/**
4 * CURLINFO_PRIMARY_IP を使用して、指定されたURLのプライマリIPアドレスを取得し表示します。
5 * この関数は、PHPのcURL拡張機能の基本的な利用方法と、
6 * 接続先の詳細情報を取得する方法をシステムエンジニアを目指す初心者に示します。
7 *
8 * @param string $url 接続先のURL。例: 'https://www.example.com'
9 * @return void
10 */
11function getAndDisplayPrimaryIpAddress(string $url): void
12{
13    // PHPにcURL拡張機能がロードされているか確認します。
14    // cURLが有効でない場合、通常はphp.iniファイルで 'extension=curl' のコメントを外し、
15    // WebサーバーまたはPHP-FPMを再起動する必要があります。
16    // `phpinfo()` 関数を実行して 'curl' の項目があるか確認することもできます。
17    if (!extension_loaded('curl')) {
18        echo "エラー: cURL拡張機能が有効ではありません。\n";
19        echo "PHP設定 (php.ini) で 'extension=curl' を有効にしてください。\n";
20        return;
21    }
22
23    // cURLセッションを初期化します。
24    $ch = curl_init();
25
26    if ($ch === false) {
27        echo "エラー: cURLセッションの初期化に失敗しました。\n";
28        return;
29    }
30
31    // cURLオプションを設定します。
32    // 接続先のURLを設定します。
33    curl_setopt($ch, CURLOPT_URL, $url);
34    // cURL_exec() が文字列として結果を返すように設定します。
35    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
36    // HTTPS接続のSSL証明書を検証するように設定します (推奨)。
37    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
38    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
39
40    // cURLリクエストを実行します。
41    $response = curl_exec($ch);
42
43    // cURL実行中にエラーが発生したか確認します。
44    if (curl_errno($ch)) {
45        echo "cURLエラーが発生しました: " . curl_error($ch) . "\n";
46    } else {
47        // リクエストが成功した場合、curl_getinfo() と CURLINFO_PRIMARY_IP を使用して
48        // 接続先のプライマリIPアドレスを取得します。
49        $primaryIp = curl_getinfo($ch, CURLINFO_PRIMARY_IP);
50
51        if ($primaryIp) {
52            echo "ターゲットURL: {$url}\n";
53            echo "接続先プライマリIPアドレス: {$primaryIp}\n";
54        } else {
55            echo "エラー: プライマリIPアドレスを取得できませんでした。\n";
56        }
57    }
58
59    // cURLセッションを閉じ、関連するリソースを解放します。
60    curl_close($ch);
61}
62
63// サンプルとして、一般的に利用可能なウェブサイトのURLを指定して関数を実行します。
64// 実際の動作確認では、アクセス可能な任意のURLを指定してください。
65getAndDisplayPrimaryIpAddress('https://www.example.com');

このPHPサンプルコードは、cURL拡張機能のCURLINFO_PRIMARY_IP定数を利用し、指定したURLのプライマリIPアドレスを取得して表示する方法を示します。システムエンジニアを目指す初心者が、PHPで外部サービスに接続する際の基本的な流れと、接続先の詳細情報を得るための基礎を学べます。

まず、コードはextension_loaded関数を用いてcURL拡張機能がPHPにロードされているかを確認します。有効でない場合は、php.iniでextension=curlを有効にし、Webサーバーなどを再起動する必要があることを促します。phpinfo()関数を実行してcURLの項目があるか確認できることにも触れています。

次に、curl_init()でcURLセッションを初期化し、curl_setopt()で接続先のURLや、レスポンスを文字列として取得する設定などを行います。その後、curl_exec()でHTTPリクエストを実行し、エラーが発生していないかcurl_errno()で確認します。

リクエストが成功した場合、curl_getinfo()関数にCURLINFO_PRIMARY_IP定数を渡すことで、実際に接続されたサーバーのプライマリIPアドレスを取得できます。取得したIPアドレスは画面に表示され、最後にcurl_close()でセッションを終了し、関連リソースを解放します。

getAndDisplayPrimaryIpAddress関数は、文字列型で接続先のURLを引数として受け取ります。この関数は画面に直接出力を行うため、戻り値はありません。

Copy
1<?php
2
3/**
4 * 指定されたURLへのcURL接続で利用されたプライマリIPアドレスを取得し、表示します。
5 *
6 * この関数は、CURLINFO_PRIMARY_IP 定数を使用して、
7 * ターゲットURLの主要なIPアドレス（接続時に実際に使われたIPアドレス）を
8 * 取得する方法を示します。
9 *
10 * @param string $url 接続するターゲットURL。例: "https://www.example.com"
11 * @return void
12 */
13function getAndDisplayPrimaryIp(string $url): void
14{
15    // cURLセッションを初期化します。
16    $ch = curl_init();
17
18    // cURLセッションの初期化に失敗した場合はエラーを表示して終了します。
19    if ($ch === false) {
20        echo "エラー: cURLセッションの初期化に失敗しました。" . PHP_EOL;
21        return;
22    }
23
24    // cURLオプションを設定します。
25    // CURLOPT_URL: 接続先のURLを指定します。
26    curl_setopt($ch, CURLOPT_URL, $url);
27    // CURLOPT_RETURNTRANSFER: curl_exec()が結果を文字列として返すようにします。
28    // これがないと、curl_exec()は直接結果を出力してしまいます。
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30
31    // cURLセッションを実行します。
32    // 実際のリクエストがここで行われます。
33    curl_exec($ch);
34
35    // cURL操作中にエラーが発生したか確認します。
36    if (curl_errno($ch)) {
37        echo "cURLエラー: " . curl_error($ch) . PHP_EOL;
38        curl_close($ch);
39        return;
40    }
41
42    // CURLINFO_PRIMARY_IP 定数を使用してプライマリIPアドレスを取得します。
43    // curl_getinfo() は、cURLセッションに関する詳細な情報を取得する関数です。
44    $primaryIp = curl_getinfo($ch, CURLINFO_PRIMARY_IP);
45
46    // 取得したプライマリIPアドレスを表示します。
47    echo "URL: " . $url . PHP_EOL;
48    echo "プライマリIPアドレス: " . $primaryIp . PHP_EOL;
49
50    // cURLセッションを閉じ、関連するリソースを解放します。
51    curl_close($ch);
52}
53
54// サンプル使用例: GoogleのプライマリIPアドレスを取得して表示します。
55getAndDisplayPrimaryIp("https://www.google.com");
56
57?>

このPHPサンプルコードは、指定されたURLへHTTPリクエストを送信し、その接続で実際に使用されたサーバーの主要なIPアドレス（プライマリIPアドレス）を取得して表示する方法を簡潔に示しています。

コードはまず、curl_init()関数でcURLセッションを開始します。次に、curl_setopt()関数を使って、接続するURL（$url引数で受け取る文字列）などのオプションを設定します。特にCURLOPT_RETURNTRANSFERは、リクエストの結果を文字列として取得するために設定されます。その後、curl_exec()関数を実行することで、実際にHTTPリクエストが送信されます。

リクエスト実行後、curl_getinfo()関数にCURLINFO_PRIMARY_IP定数を指定することで、cURLセッションが実際に接続したサーバーのプライマリIPアドレスを取得できます。この定数は、接続に関する詳細な情報の中から、接続に使用された主要なIPアドレスを示す役割を持っています。取得されたIPアドレスは画面に表示され、最後にcurl_close()関数でcURLセッションを終了し、関連するリソースを解放します。

getAndDisplayPrimaryIp関数は、接続先のURLを表す文字列を引数として受け取ります。この関数はIPアドレスを表示するだけで、特定の値を呼び出し元に返すことはありません（戻り値はvoidです）。この一連の処理により、特定のウェブサイトの接続先IPアドレスを手軽に確認できる基本的な方法を理解することができます。