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

Copy
1<?php
2
3/**
4 * リファレンス情報に基づき、CURLPX_REPLY_UNASSIGNED 定数を定義します。
5 * この定数は、何らかの「未割り当て」または「不明」な状態を示す整数値と想定されます。
6 * 通常のHTTPステータスコードと区別するため、負の値を設定します。
7 */
8if (!defined('CURLPX_REPLY_UNASSIGNED')) {
9    define('CURLPX_REPLY_UNASSIGNED', -1);
10}
11
12/**
13 * 指定されたURLに対してcURLリクエストを実行し、HTTPレスポンスコードを取得します。
14 * cURLの初期化失敗、実行エラー、またはレスポンスコードが取得できなかった場合は、
15 * CURLPX_REPLY_UNASSIGNED 定数の値を返します。
16 *
17 * @param string $url リクエストを送信するURL。
18 * @return int HTTPレスポンスコード、または CURLPX_REPLY_UNASSIGNED の値。
19 */
20function getCurlInfoResponseCode(string $url): int
21{
22    // cURLセッションを初期化
23    $ch = curl_init();
24
25    // cURL初期化に失敗した場合
26    if ($ch === false) {
27        return CURLPX_REPLY_UNASSIGNED;
28    }
29
30    // cURLオプションを設定
31    curl_setopt($ch, CURLOPT_URL, $url);
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // レスポンスを文字列として取得
33    curl_setopt($ch, CURLOPT_HEADER, false);       // レスポンスヘッダーを含めない
34    curl_setopt($ch, CURLOPT_TIMEOUT, 10);         // タイムアウトを10秒に設定
35    // HTTPSサイトでの証明書検証を無効化 (開発・テスト用途では便利ですが、本番環境ではセキュリティリスクがあります)
36    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
37    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
38
39    // cURLリクエストを実行
40    $response = curl_exec($ch);
41
42    // cURL実行中にエラーが発生した場合
43    if ($response === false) {
44        curl_close($ch);
45        return CURLPX_REPLY_UNASSIGNED;
46    }
47
48    // HTTPレスポンスコードを取得
49    // キーワード 'curlinfo_response_code' に対応する主要な処理です。
50    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
51
52    // cURLセッションを閉じる
53    curl_close($ch);
54
55    // HTTPコードが0の場合（例えば、DNS解決失敗などのネットワークエラー）も
56    // CURLPX_REPLY_UNASSIGNED の状態とみなすことができます。
57    if ($httpCode === 0) {
58        return CURLPX_REPLY_UNASSIGNED;
59    }
60
61    // 取得したHTTPステータスコードを返す
62    return (int)$httpCode;
63}
64
65// --- サンプル実行 ---
66
67// 存在するURLへのリクエスト例
68$url1 = 'https://www.google.com/';
69echo "URL: {$url1}\n";
70$statusCode1 = getCurlInfoResponseCode($url1);
71echo "HTTP Status Code: {$statusCode1}\n\n";
72
73// 存在しないページへのリクエスト例 (通常は404 Not Found)
74$url2 = 'https://www.google.com/nonexistent-path-12345';
75echo "URL: {$url2}\n";
76$statusCode2 = getCurlInfoResponseCode($url2);
77echo "HTTP Status Code: {$statusCode2}\n\n";
78
79// 解決できない（存在しない）ドメインへのリクエスト例 (CURLエラーとなり、CURLPX_REPLY_UNASSIGNEDが返される可能性が高い)
80$url3 = 'http://invalid.example.domain/';
81echo "URL: {$url3}\n";
82$statusCode3 = getCurlInfoResponseCode($url3);
83echo "HTTP Status Code: {$statusCode3}\n\n";
84
85// 定数CURLPX_REPLY_UNASSIGNEDの値を確認
86echo "CURLPX_REPLY_UNASSIGNED value: " . CURLPX_REPLY_UNASSIGNED . "\n";
87
88?>

このPHPコードは、cURL拡張機能を用いて、指定されたURLのHTTPレスポンスコードを取得する方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。

最初に、CURLPX_REPLY_UNASSIGNEDという定数を定義しています。これは、ウェブサイトとの通信中にエラーが発生したり、レスポンスコードが何らかの理由で取得できなかったりした場合に、「未割り当て」や「不明」な状態を示す特別な整数値として利用されます。ここでは、通常のHTTPステータスコードと区別するために、負の値-1が割り当てられています。

主要な機能はgetCurlInfoResponseCode関数で提供されます。この関数は引数として、リクエストを送信するURL（文字列）を受け取ります。内部ではcURLセッションを初期化し、URLの設定やタイムアウト、レスポンスを文字列として取得するオプションなどを設定します。その後、実際にcurl_exec関数でウェブサイトへリクエストを実行します。

リクエストの実行後、重要なのがcurl_getinfo関数とCURLINFO_HTTP_CODEオプションです。この部分で、ウェブサーバーから返されたHTTPレスポンスコード（例えば、通信成功を示す200や、ページが見つからないことを示す404など）を取得します。もしcURLの初期化に失敗した場合や、リクエストの実行中にエラーが発生した場合、またはHTTPコードが0（通常はネットワークレベルのエラー）だった場合には、定義したCURLPX_REPLY_UNASSIGNEDの値を関数の戻り値として返します。正常にHTTPレスポンスコードが取得できた場合は、その整数値を返します。

このように、このコードはウェブサイトとの通信結果を正確に把握し、エラー時にも適切に処理するための基本的な手法を示しており、外部サービスとの連携が必要なシステム開発で役立つ知識となります。

Copy
1<?php
2
3/**
4 * リモートURLからデータをフェッチする関数。
5 * システムエンジニアを目指す初心者向けに、cURLの基本的な使い方とエラー処理を示します。
6 * CURLPX_REPLY_UNASSIGNED 定数が何らかの特定のエラー状態やカスタム応答コードを示すと仮定し、
7 * cURL操作の結果と比較する例を含みます。
8 *
9 * @param string $url フェッチするターゲットURL。
10 * @return string|false 成功した場合はフェッチされたデータ、失敗した場合はfalse。
11 */
12function fetchRemoteData(string $url): string|false
13{
14    // cURLセッションを初期化します。
15    $ch = curl_init();
16
17    // cURLオプションを設定します。
18    // CURLOPT_URL: リクエストを送信するURL。
19    curl_setopt($ch, CURLOPT_URL, $url);
20    // CURLOPT_RETURNTRANSFER: 実行結果を文字列で返すように設定します。
21    // trueに設定しないと、結果が直接出力されます。
22    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
23    // CURLOPT_TIMEOUT: cURL操作の最大実行時間を秒単位で設定します。
24    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
25    // CURLOPT_FOLLOWLOCATION: HTTPヘッダーの"Location:"に従ってリダイレクトを処理します。
26    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
27    // CURLOPT_SSL_VERIFYPEER: SSL証明書の検証を有効にします (本番環境では推奨)。
28    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
29
30    // cURLリクエストを実行し、応答を取得します。
31    $response = curl_exec($ch);
32
33    // cURL実行中にエラーが発生したかチェックします。
34    if (curl_errno($ch)) {
35        echo 'cURL Error: ' . curl_error($ch) . PHP_EOL;
36        // cURLのエラーコードが CURLPX_REPLY_UNASSIGNED と一致するかをチェックする例。
37        // この定数は特定のカスタムエラーや状態を示すことを想定しています。
38        // (CURLPX_REPLY_UNASSIGNED はPHP標準のCURL拡張には含まれない可能性が高いですが、
39        // 提供されたリファレンス情報に基づき、存在すると仮定して使用します。)
40        if (curl_errno($ch) === CURLPX_REPLY_UNASSIGNED) {
41            echo 'Detected a custom "unassigned reply" cURL error: ' . CURLPX_REPLY_UNASSIGNED . PHP_EOL;
42        }
43        curl_close($ch);
44        return false;
45    }
46
47    // HTTPステータスコードを取得します。
48    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
49
50    // cURLセッションを終了します。
51    curl_close($ch);
52
53    // HTTPステータスコードが CURLPX_REPLY_UNASSIGNED と一致するかをチェックする例。
54    // 例えば、CURLPX_REPLY_UNASSIGNED が特定のHTTPステータスコード（例: 0やカスタムコード）を
55    // 表すと仮定する場合に利用できます。
56    if ($httpCode === CURLPX_REPLY_UNASSIGNED) {
57        echo 'Received HTTP status code matching CURLPX_REPLY_UNASSIGNED (' . CURLPX_REPLY_UNASSIGNED . ').' . PHP_EOL;
58        // この定数が示す特定の未割り当て応答に対する処理を行うことができます。
59        return false;
60    } elseif ($httpCode >= 200 && $httpCode < 300) {
61        // 成功したHTTPステータスコードの範囲 (2xx)
62        echo 'HTTP request successful with status ' . $httpCode . '.' . PHP_EOL;
63        return $response;
64    } else {
65        // その他のエラーHTTPステータスコード
66        echo 'HTTP request failed with status ' . $httpCode . '.' . PHP_EOL;
67        return false;
68    }
69}
70
71// サンプルURLを使用して関数を実行します。
72// 実際に存在するURLに置き換えて試してください。
73$sampleUrl = 'https://jsonplaceholder.typicode.com/posts/1';
74echo "Attempting to fetch data from: " . $sampleUrl . PHP_EOL;
75
76$fetchedData = fetchRemoteData($sampleUrl);
77
78if ($fetchedData !== false) {
79    echo "Successfully fetched data (first 150 chars):" . PHP_EOL;
80    echo substr($fetchedData, 0, 150) . '...' . PHP_EOL;
81} else {
82    echo "Failed to fetch data." . PHP_EOL;
83}

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたURLからWebデータを取得する方法をシステムエンジニアを目指す初心者向けに示しています。fetchRemoteData 関数は、引数として取得したいWebサイトのアドレス（文字列）を受け取ります。

まず、curl_init() でcURLセッションを開始し、curl_setopt() を使ってリクエストのURL、データの戻り値形式、タイムアウト時間、リダイレクト追従、SSL証明書検証などの詳細な設定を行います。設定後、curl_exec() で実際にWebリクエストを実行し、その応答を取得します。

通信中にエラーが発生した場合は、curl_errno() や curl_error() を使ってcURL自体のエラーを確認し、適切な処理を行います。また、curl_getinfo() で取得できるHTTPステータスコードを確認することで、Webサーバーからの応答が成功（2xx）したか、エラー（4xx、5xxなど）だったかを判断します。

ここで使用されている CURLPX_REPLY_UNASSIGNED 定数は、拡張機能によって定義される整数型の値で、特定の未割り当て応答やカスタムエラー状態を示すことを想定しています。サンプルコードでは、cURLのエラーコードやHTTPステータスコードがこの定数の値と一致するかを比較し、特定の状況を検出する例として利用されています。

関数は、データ取得に成功した場合は取得したWebデータ（文字列）を、失敗した場合は false を戻り値として返します。この一連の流れを通じて、外部リソースとの安全な連携方法を学ぶことができます。