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

Copy
1<?php
2
3/**
4 * 指定されたURLへのHTTPリクエストを実行し、そのHTTPステータスコードを取得します。
5 *
6 * この関数は、PHPのcURL拡張機能を使用し、特にCURLINFO_HTTP_CODE定数を利用して
7 * リクエスト結果のHTTPステータス（例: 200 OK, 404 Not Found）を取得します。
8 * システムエンジニアを目指す初心者の方でも理解しやすいよう、基本的なcURLの
9 * 使用方法とエラーハンドリングを含んでいます。
10 *
11 * @param string $url リクエストを送信するURL。
12 * @return int|false HTTPステータスコード (例: 200, 404) またはエラー時に false。
13 */
14function getHttpStatusFromUrl(string $url): int|false
15{
16    // cURL セッションを初期化します。
17    // cURL は様々なプロトコル（HTTP, HTTPS, FTPなど）でデータ転送を行うためのライブラリです。
18    $ch = curl_init($url);
19
20    // cURL 初期化が失敗した場合は false を返します。
21    // 例: メモリ不足などのシステムレベルのエラー。
22    if ($ch === false) {
23        error_log("cURL initialization failed for URL: " . $url);
24        return false;
25    }
26
27    // CURLOPT_RETURNTRANSFER オプションを true に設定します。
28    // これにより、curl_exec() が実行結果を直接出力する代わりに、文字列として返します。
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30
31    // CURLOPT_NOBODY オプションを true に設定します。
32    // これにより、HTTPリクエストは応答ボディを要求せず、ヘッダーのみを取得します。
33    // ステータスコードの取得が目的の場合、ボディは不要なので処理を高速化できます。
34    curl_setopt($ch, CURLOPT_NOBODY, true);
35
36    // HTTPリクエストを実行します。
37    // 応答ボディが不要なため、$response には通常は空文字列が格納されます（エラーでない場合）。
38    $response = curl_exec($ch);
39
40    // cURL 実行が失敗した場合は false を返します。
41    // 例: ネットワーク接続の問題、DNS解決エラーなど。
42    if ($response === false) {
43        error_log("cURL request failed for URL: " . $url . " - " . curl_error($ch));
44        curl_close($ch); // エラー発生時もcURLセッションを閉じます
45        return false;
46    }
47
48    // curl_getinfo() を使用して、転送に関する情報を取得します。
49    // CURLINFO_HTTP_CODE 定数を指定することで、HTTPステータスコード（例: 200, 404）を取得します。
50    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
51
52    // cURL セッションを閉じ、リソースを解放します。
53    curl_close($ch);
54
55    return $httpCode;
56}
57
58// === サンプルコードの実行例 ===
59// このブロックは関数が単体で動作することを示すために含まれています。
60
61// cURL拡張機能がロードされているかを確認します。
62// ロードされていない場合、cURL関数は動作しません。
63if (extension_loaded('curl')) {
64    echo "cURL extension is loaded." . PHP_EOL . PHP_EOL;
65
66    // 存在するURLの例
67    $url1 = 'https://example.com';
68    $status1 = getHttpStatusFromUrl($url1);
69    if ($status1 !== false) {
70        echo "Status code for '{$url1}': {$status1}" . PHP_EOL; // 期待される出力: 200
71    } else {
72        echo "Failed to get status code for '{$url1}'." . PHP_EOL;
73    }
74
75    // 存在しないURLの例
76    $url2 = 'https://example.com/non-existent-page-12345';
77    $status2 = getHttpStatusFromUrl($url2);
78    if ($status2 !== false) {
79        echo "Status code for '{$url2}': {$status2}" . PHP_EOL; // 期待される出力: 404
80    } else {
81        echo "Failed to get status code for '{$url2}'." . PHP_EOL;
82    }
83
84    // 無効なURL（ドメインが存在しないなど）の例
85    $url3 = 'https://invalid-domain-example-12345.com';
86    $status3 = getHttpStatusFromUrl($url3);
87    if ($status3 !== false) {
88        echo "Status code for '{$url3}': {$status3}" . PHP_EOL; // ネットワークエラーの場合、ステータスコードは取得できないことがある
89    } else {
90        echo "Failed to get status code for '{$url3}' (e.g., DNS error or connection issue)." . PHP_EOL;
91    }
92} else {
93    echo "cURL extension is not loaded. Please enable it in your php.ini configuration." . PHP_EOL;
94}

このPHPコードは、指定されたURLに対するHTTPリクエストを実行し、そのHTTPステータスコード（例: 200 OK、404 Not Found）を取得する一連の流れを示しています。システムエンジニアを目指す初心者の方にも理解しやすいように、PHPのcURL拡張機能の基本的な利用方法とエラーハンドリングが組み込まれています。

getHttpStatusFromUrl関数は、引数に指定された$urlに対しHTTPリクエストを送信します。まずcurl_init()でcURLセッションを初期化し、データ転送の準備を行います。初期化に失敗した場合はfalseを返します。次に、curl_setopt()関数を使ってcURLの動作オプションを設定します。CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果を文字列として取得できるようになり、CURLOPT_NOBODYをtrueに設定することで、HTTP応答のボディ部を要求せずヘッダー情報のみを取得するため、ステータスコードの取得に特化し処理を高速化します。

HTTPリクエストはcurl_exec()で実行され、ネットワークの問題などで失敗した場合はエラーが記録されfalseが戻り値となります。リクエストが成功した場合、curl_getinfo()関数とCURLINFO_HTTP_CODE定数を利用して、HTTPステータスコードを整数値で取得します。CURLINFO_HTTP_CODEは、Webサーバーが応答として返したHTTPステータスコードを示す定数です。最後にcurl_close()でcURLセッションを終了し、確保されたリソースを解放します。この関数は最終的に、取得したHTTPステータスコードを整数値で返すか、処理中にエラーが発生した場合はfalseを返します。

Copy
1<?php
2
3/**
4 * PHP 8で追加された定数 CURLINFO_CONDITION_UNMET の値と、
5 * cURLハンドルの情報を取得する curl_getinfo() 関数の一般的な使い方を示すサンプルコードです。
6 *
7 * CURLINFO_CONDITION_UNMET 定数は、主に条件付きHTTPリクエスト（例: If-Modified-Sinceヘッダ）が
8 * 満たされなかった場合に、libcurlライブラリ内部で特定の状態を示すために使用されるものと推測されます。
9 *
10 * この定数自体は、curl_getinfo() 関数の第二引数として情報を取得するために直接渡すことはできません。
11 * また、curl_getinfo() が返す情報配列のキーとして直接現れることもありません。
12 * そのため、このサンプルでは定数の値を確認し、その後で一般的な cURL 情報の取得方法を紹介します。
13 */
14function demonstrateCurlInfoConditionUnmet(): void
15{
16    // CURLINFO_CONDITION_UNMET 定数の値を出力します。
17    // この値はPHPのバージョンによって異なる場合がありますが、常に整数です。
18    echo "CURLINFO_CONDITION_UNMET の値: " . CURLINFO_CONDITION_UNMET . PHP_EOL . PHP_EOL;
19
20    // サンプルとして情報を取得する対象のURL
21    $url = 'https://www.example.com'; 
22
23    // cURL セッションを初期化します。
24    // cURL_init() は cURL ハンドル（リソース）を返します。
25    $ch = curl_init();
26
27    // 初期化に失敗した場合のチェック
28    if ($ch === false) {
29        echo "cURL セッションの初期化に失敗しました。" . PHP_EOL;
30        return;
31    }
32
33    // cURL オプションを設定します。
34    // CURLOPT_URL: リクエストを送信するURL
35    curl_setopt($ch, CURLOPT_URL, $url);
36    // CURLOPT_RETURNTRANSFER: curl_exec() が結果を文字列として返すようにします。
37    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
38    // CURLOPT_HEADER: レスポンスヘッダーを結果に含めないようにします。
39    curl_setopt($ch, CURLOPT_HEADER, false);
40    // CURLOPT_NOBODY: レスポンスボディを含めないようにします。情報取得のみが目的の場合に便利です。
41    curl_setopt($ch, CURLOPT_NOBODY, true);
42
43    // cURL セッションを実行します。
44    // CURLOPT_NOBODY が true なので、$response は空文字列または false になります。
45    $response = curl_exec($ch);
46
47    // cURL 実行時のエラーをチェックします。
48    if ($response === false) {
49        echo "cURL エラー: " . curl_error($ch) . PHP_EOL;
50    } else {
51        // curl_getinfo() を使用して、実行された cURL セッションの様々な情報を取得します。
52        // これは連想配列として多くの情報（HTTPステータスコード、コンテンツタイプなど）を返します。
53        // CURLINFO_CONDITION_UNMET はこの情報配列のキーとしては含まれません。
54        $info = curl_getinfo($ch);
55
56        echo "cURL セッションから取得された情報:" . PHP_EOL;
57        echo "  要求された URL: " . ($info['url'] ?? 'N/A') . PHP_EOL;
58        echo "  最終的な HTTP ステータスコード: " . ($info['http_code'] ?? 'N/A') . PHP_EOL;
59        echo "  サーバーのコンテンツタイプ: " . ($info['content_type'] ?? 'N/A') . PHP_EOL;
60        echo "  ダウンロード速度 (バイト/秒): " . ($info['speed_download'] ?? 'N/A') . PHP_EOL;
61        echo "  リクエストにかかった総時間 (秒): " . ($info['total_time'] ?? 'N/A') . PHP_EOL;
62
63        // より詳細な情報が存在する場合にのみ表示する例
64        if (isset($info['size_download'])) {
65            echo "  ダウンロードされたボディのサイズ: " . $info['size_download'] . "バイト" . PHP_EOL;
66        }
67    }
68
69    // cURL セッションを閉じ、リソースを解放します。
70    curl_close($ch);
71}
72
73// 上記の関数を実行して、CURLINFO_CONDITION_UNMET の値と cURL の情報を表示します。
74demonstrateCurlInfoConditionUnmet();
75

このPHPコードは、PHP 8で追加された定数CURLINFO_CONDITION_UNMETの値と、cURLを利用してHTTPリクエストの情報を取得するcurl_getinfo()関数の基本的な使い方を、システムエンジニアを目指す初心者向けに解説しています。

CURLINFO_CONDITION_UNMETは、libcurlライブラリ内部で特定の状態を示すために使われる整数定数です。例えば、条件付きHTTPリクエストが満たされなかった場合などに参照されると考えられます。この定数自体は、curl_getinfo()関数の情報を取得するための引数として直接渡したり、返される情報配列のキーとして現れたりするものではありません。サンプルコードでは、まずこの定数の具体的な値を出力しています。

次に、cURLセッションの基本的な処理フローを示します。まずcurl_init()関数でcURLハンドルというリソースを初期化し、これを引数としてcurl_setopt()関数でアクセス先のURLやレスポンスの扱い方などのオプションを設定します。オプション設定後、curl_exec()関数で実際にHTTPリクエストを実行します。リクエスト実行後、curl_getinfo()関数を引数なしで呼び出すことで、HTTPステータスコード、コンテンツタイプ、処理にかかった時間など、実行されたcURLセッションに関する様々な情報を連想配列として取得できます。最後にcurl_close()関数を呼び出して、cURLセッションを閉じ、関連するリソースを解放します。