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

Copy
1<?php
2
3/**
4 * 指定されたURLへのHTTPリクエストを実行し、HTTPステータスコードを取得します。
5 *
6 * この関数は、PHPのCURL拡張機能を使用してウェブページにアクセスし、
7 * その応答のHTTPステータスコード（例: 200 OK, 404 Not Found）を取得します。
8 * システムエンジニアを目指す初心者にとって、HTTP通信の基本的な仕組みと、
9 * それをPHPでどのように扱うかを理解するのに役立ちます。
10 *
11 * @param string $url リクエストを送信するターゲットURL
12 * @return int|false 成功した場合はHTTPステータスコード (例: 200)、失敗した場合は false
13 */
14function getHttpStatusCode(string $url): int|false
15{
16    // 1. CURLセッションを初期化します。
17    //    これにより、CURLライブラリを使用するためのハンドルが作成されます。
18    $ch = curl_init();
19
20    // 2. CURLオプションを設定します。
21    //    これらのオプションは、CURLがどのようにリクエストを処理するかを定義します。
22
23    //    CURLOPT_URL: リクエストを送信するURLを設定します。
24    curl_setopt($ch, CURLOPT_URL, $url);
25
26    //    CURLOPT_RETURNTRANSFER: true に設定すると、curl_exec() は取得したデータを文字列として返します。
27    //    false の場合、データは直接出力されます。今回はステータスコードのみに関心がありますが、
28    //    一般的なHTTPリクエスト処理ではこの設定がよく使われます。
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30
31    //    CURLOPT_HEADER: true に設定すると、レスポンスヘッダーも出力に含まれます。
32    //    今回はステータスコードのみが必要なので、false に設定してヘッダーを除外します。
33    curl_setopt($ch, CURLOPT_HEADER, false);
34
35    // 3. CURLリクエストを実行します。
36    //    ここで実際に指定したURLへのHTTPリクエストが送信されます。
37    $response = curl_exec($ch);
38
39    // 4. エラーチェックを行います。
40    //    リクエストの実行中にエラーが発生した場合は、その情報を表示して処理を終了します。
41    if (curl_errno($ch)) {
42        echo 'CURLエラーが発生しました: ' . curl_error($ch) . PHP_EOL;
43        curl_close($ch);
44        return false;
45    }
46
47    // 5. HTTPステータスコードを取得します。
48    //    curl_getinfo() 関数は、CURLセッションに関する様々な情報を取得するために使用されます。
49    //    CURLINFO_HTTP_CODE は、取得したい情報が「最後に受信したHTTPステータスコード」であることを示します。
50    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
51
52    // 6. CURLセッションを閉じます。
53    //    リソースを解放し、メモリリークを防ぐために重要です。
54    curl_close($ch);
55
56    return $httpCode;
57}
58
59// -----------------------------------------------------------
60// 以下は、getHttpStatusCode 関数を実際に使用する例です。
61// -----------------------------------------------------------
62
63// テスト用のURLを設定します。ご自身の検証したいURLに変更しても構いません。
64$targetUrl = 'https://www.google.com'; // 成功するはずのURL
65// $targetUrl = 'https://example.com/nonexistent-page'; // 404 Not Found を返す可能性のあるURL
66// $targetUrl = 'https://invalid-domain-name.com'; // CURLエラーを返す可能性のあるURL
67
68echo "URL: {$targetUrl} へのHTTPリクエストを試行中..." . PHP_EOL;
69
70// 関数を呼び出してHTTPステータスコードを取得します。
71$statusCode = getHttpStatusCode($targetUrl);
72
73if ($statusCode !== false) {
74    // 取得したステータスコードを表示します。
75    echo "HTTPステータスコード: {$statusCode}" . PHP_EOL;
76
77    // ステータスコードに応じて簡単な説明を表示します。
78    if ($statusCode === 200) {
79        echo "  -> 成功しました (OK)." . PHP_EOL;
80    } elseif ($statusCode === 404) {
81        echo "  -> ページが見つかりません (Not Found)." . PHP_EOL;
82    } elseif ($statusCode >= 400 && $statusCode < 500) {
83        echo "  -> クライアントエラーが発生しました (例: リクエストが不正)." . PHP_EOL;
84    } elseif ($statusCode >= 500 && $statusCode < 600) {
85        echo "  -> サーバーエラーが発生しました (例: サーバー側の問題)." . PHP_EOL;
86    } else {
87        echo "  -> その他のステータスコードです。" . PHP_EOL;
88    }
89} else {
90    echo "HTTPステータスコードの取得に失敗しました。上記のエラーメッセージを確認してください。" . PHP_EOL;
91}

PHPのCURL拡張機能は、プログラムからHTTP通信を行うための機能を提供します。このサンプルコードは、CURLを使って指定されたURLへHTTPリクエストを実行し、その応答として返されるHTTPステータスコードを取得する手順を、システムエンジニアを目指す初心者の方にも分かりやすく解説しています。これにより、ウェブページの可用性やサーバーの状態をプログラムで確認できるようになります。

コードの中心となるgetHttpStatusCode関数は、まずcurl_initでCURLセッションを開始します。次にcurl_setopt関数で、リクエストを送信するURLをCURLOPT_URLオプションに設定するなど、通信に関する詳細なオプションを設定します。その後、curl_execで実際にHTTPリクエストを実行し、その結果として返される情報を取得します。リクエストの実行後にエラーが発生していないかを確認し、問題がなければcurl_getinfo関数とCURLINFO_HTTP_CODE定数を用いて、最後に受信したHTTPステータスコードを取得します。この定数は、HTTPリクエストの成功（200 OK）やページが見つからない（404 Not Found）といったコードそのものを意味します。最後にcurl_closeでCURLセッションを終了し、リソースを解放します。

この関数の引数$urlは、リクエストを送信するターゲットURLの文字列を受け取ります。戻り値としては、リクエストが成功しステータスコードが取得できた場合はその整数値（例: 200）、何らかの理由で取得に失敗した場合はfalseを返します。

Copy
1<?php
2
3/**
4 * 指定されたURLにcURLリクエストを送信し、
5 * HTTPレスポンスコードとcURLセッションが認識しているクッキーリストを取得して表示します。
6 * システムエンジニアを目指す初心者向けに、cURLの基本的な使い方と
7 * CURLINFO_RESPONSE_CODE、CURLINFO_COOKIELISTの利用例を示します。
8 *
9 * @param string $url リクエストを送信するURL
10 * @return void
11 */
12function fetchUrlInfo(string $url): void
13{
14    // cURLセッションを初期化
15    $ch = curl_init();
16
17    // cURLオプションを設定
18    // リクエスト先のURLを設定
19    curl_setopt($ch, CURLOPT_URL, $url);
20    // サーバーからのレスポンスを直接出力せず、文字列として取得するように設定
21    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
22    // HTTPリダイレクトが発生した場合に、自動的にそのリダイレクト先を追跡するように設定
23    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
24    // クッキー情報を記憶し、後続のリクエストや cURL_getinfo() で利用できるようにする
25    // これがないと、CURLINFO_COOKIELIST は常に空になる可能性があります。
26    curl_setopt($ch, CURLOPT_COOKIEJAR, 'php://memory'); // クッキーをメモリ上で管理
27
28    // HTTPリクエストを実行
29    // レスポンスの内容自体は、この例では表示しません
30    $response = curl_exec($ch);
31
32    // エラーチェック
33    if (curl_errno($ch)) {
34        // cURLの実行中にエラーが発生した場合、エラーメッセージを表示
35        echo 'cURL エラー: ' . curl_error($ch) . PHP_EOL;
36    } else {
37        // curl_getinfo() を使用して、実行後のcURLセッションから各種情報を取得
38
39        // CURLINFO_RESPONSE_CODE: HTTPレスポンスのステータスコード（例: 200 OK, 404 Not Found）を取得
40        $httpResponseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
41        echo "リクエストURL: {$url}" . PHP_EOL;
42        echo "HTTP レスポンスコード: {$httpResponseCode}" . PHP_EOL;
43
44        // CURLINFO_COOKIELIST: cURLセッションが認識しているクッキーのリストを取得
45        // このリストには、アクセスしたサイトから設定されたクッキーなどが含まれます。
46        // 返されるのは、RFC 6265 形式に近い文字列の配列です。
47        $cookieList = curl_getinfo($ch, CURLINFO_COOKIELIST);
48        if (!empty($cookieList)) {
49            echo "取得したクッキーリスト (" . count($cookieList) . "個):" . PHP_EOL;
50            foreach ($cookieList as $cookieInfo) {
51                // クッキー情報は、ドメイン、フラグ、パス、セキュア、有効期限、名前、値の形式で提供されます
52                echo "- " . $cookieInfo . PHP_EOL;
53            }
54        } else {
55            echo "クッキーは取得されませんでした。" . PHP_EOL;
56        }
57    }
58
59    // cURLセッションを閉じる（リソースを解放）
60    curl_close($ch);
61}
62
63// --- サンプル実行 ---
64
65// 例1: クッキーが設定される可能性のあるテスト用URLへのリクエスト
66// このURLにアクセスすると 'foo=bar' というクッキーが設定されます。
67$targetUrlWithCookie = 'https://httpbin.org/cookies/set?foo=bar';
68echo "--- クッキーが設定されるURLへのリクエスト ---" . PHP_EOL;
69fetchUrlInfo($targetUrlWithCookie);
70
71echo PHP_EOL;
72
73// 例2: 一般的なWebサイトへのリクエスト
74// 多くのサイトでは、単純なGETリクエストではクッキーが設定されない場合があります。
75$anotherTargetUrl = 'https://www.example.com';
76echo "--- 一般的なサイトへのリクエスト ---" . PHP_EOL;
77fetchUrlInfo($anotherTargetUrl);

このPHPのサンプルコードは、cURL拡張機能を用いて指定されたURLへHTTPリクエストを送信し、その結果からWebサイトの重要な情報を取得する方法を示しています。まずcurl_init()でcURLセッションを開始し、curl_setopt()関数で様々な設定を行います。ここでは、レスポンスを文字列として取得するCURLOPT_RETURNTRANSFERや、リダイレクトを追跡するCURLOPT_FOLLOWLOCATION、そしてクッキー情報をメモリ上で管理するCURLOPT_COOKIEJARなどを設定しています。特にCURLOPT_COOKIEJARの設定は、後続のCURLINFO_COOKIELISTでクッキー情報を取得するために重要です。

curl_exec()で実際のHTTPリクエストが実行された後、curl_getinfo()関数を使ってセッションから具体的な情報を引き出します。curl_getinfo()にCURLINFO_RESPONSE_CODE定数を指定すると、Webサーバーから返されたHTTPステータスコード（例えば「200 OK」や「404 Not Found」など）を整数値で取得できます。これにより、リクエストが成功したか、あるいは何らかの問題が発生したかを判断できます。

また、curl_getinfo()にCURLINFO_COOKIELIST定数を指定すると、cURLセッションが認識しているクッキー情報が文字列の配列として取得されます。この配列の各要素は、ドメインやパス、有効期限、クッキーの名前と値など、クッキーの詳細情報を含んでいます。もしクッキーが設定されていない場合や、CURLOPT_COOKIEJARが適切に設定されていない場合は、空の配列が返されます。

最後に、エラーが発生していないかcurl_errno()で確認し、全ての処理が終わったらcurl_close()でcURLセッションを閉じ、使用したリソースを解放しています。このサンプルは、Webサイトの基本的な情報の取得と、クッキー管理の重要性を学ぶ上で役立ちます。