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

Copy
1<?php
2
3/**
4 * CURLOPT_HTTP09_ALLOWED と CURLOPT_HTTPHEADER を使用したcURLリクエストを実行します。
5 *
6 * この関数は、HTTP/0.9の応答を許可しつつ、カスタムHTTPヘッダーを送信するcURLリクエストの例を示します。
7 * CURLOPT_HTTP09_ALLOWED はPHP 8で追加された定数オプションです。
8 *
9 * @param string $url リクエストを送信するターゲットURL。
10 * @return string|false cURLリクエストの応答本文、またはエラーの場合は false。
11 */
12function performCurlRequestWithHttpOptions(string $url)
13{
14    // cURLセッションを初期化します。
15    $ch = curl_init();
16
17    if ($ch === false) {
18        echo "cURLセッションの初期化に失敗しました。\n";
19        return false;
20    }
21
22    // リクエストを送信するURLを設定します。
23    curl_setopt($ch, CURLOPT_URL, $url);
24
25    // HTTP/0.9の応答を許可するかどうかを設定します (PHP 8 以降で利用可能)。
26    // このオプションがtrueの場合、libcurlはHTTP/0.9の応答を受け入れます。
27    // HTTP/0.9は非常に古く、応答ヘッダーを持たないシンプルなプロトコルです。
28    // 現代のWebサービスでは通常使用されませんが、特定のレガシーシステムとの連携で必要になる場合があります。
29    curl_setopt($ch, CURLOPT_HTTP09_ALLOWED, true);
30
31    // リクエストに含めるカスタムHTTPヘッダーを設定します。
32    // ここで設定されたヘッダーは、リクエストと共にサーバーに送信されます。
33    $headers = [
34        'User-Agent: Sample-App/1.0 (PHP)',
35        'Accept: application/json',
36        'X-Custom-Header: MyTestValue',
37    ];
38    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
39
40    // curl_exec() の結果を直接出力するのではなく、文字列として返すように設定します。
41    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
42
43    // cURLリクエストを実行し、応答を取得します。
44    $response = curl_exec($ch);
45
46    // エラーが発生したかどうかを確認します。
47    if (curl_errno($ch)) {
48        echo 'cURLエラー: ' . curl_error($ch) . "\n";
49        $response = false;
50    }
51
52    // cURLセッションを閉じ、リソースを解放します。
53    curl_close($ch);
54
55    return $response;
56}
57
58// サンプルとして、Googleのトップページにリクエストを送信します。
59// （注: GoogleはHTTP/0.9を返しませんが、オプションの設定例として機能します）
60$targetUrl = 'https://www.google.com/';
61echo "URL: {$targetUrl} へのcURLリクエストを開始します...\n";
62$result = performCurlRequestWithHttpOptions($targetUrl);
63
64if ($result !== false) {
65    echo "\n--- レスポンスの最初の200文字 ---\n";
66    // 応答が非常に長い場合を考慮し、最初の部分のみを表示します。
67    echo substr($result, 0, 200) . "...\n";
68} else {
69    echo "cURLリクエスト中にエラーが発生しました。\n";
70}

このPHPサンプルコードは、cURLライブラリを用いてHTTPリクエストを実行する方法を示しています。performCurlRequestWithHttpOptions関数は、引数$urlで指定されたURLへリクエストを送信し、成功時にはサーバーからの応答本文を文字列で、エラー時にはfalseを戻り値として返します。

関数内では、まずcurl_init()でcURLセッションを初期化し、CURLOPT_URLオプションでリクエスト先のURLを設定します。PHP 8から追加されたCURLOPT_HTTP09_ALLOWEDオプションをtrueに設定することで、応答ヘッダーを持たない古いプロトコルであるHTTP/0.9の応答を許可します。これは特定のレガシーシステムとの連携で必要となる場合があります。

また、CURLOPT_HTTPHEADERオプションでは、User-AgentやAcceptなどのカスタムHTTPヘッダーを配列で指定し、リクエストと共にサーバーへ送信します。CURLOPT_RETURNTRANSFERオプションにより、curl_exec()の結果は文字列として取得されます。最終的にcurl_exec()でリクエストを実行し、エラー確認後にcurl_close()でリソースを解放します。このコードは、HTTPリクエストの柔軟な制御と、主要なcURLオプションの利用方法を学ぶための具体的な例です。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたURLに対して cURL リクエストを実行し、レスポンスのヘッダーとボディを返します。
7 *
8 * この関数は、CURLオプションを設定してHTTPリクエストを行います。
9 * 特に、キーワードで指定された`CURLOPT_HEADER`オプションと、
10 * リファレンス情報で指定された`CURLOPT_HTTP09_ALLOWED`オプションを明示的に設定しています。
11 *
12 * @param string $url リクエストを送信するターゲットURL。
13 * @return array{header: string, body: string}|false リクエストが成功した場合はヘッダーとボディを含む連想配列、
14 *                                                     失敗した場合は false を返します。
15 */
16function fetchUrlWithCurlOptions(string $url): array|false
17{
18    // cURL セッションを初期化します
19    $ch = curl_init();
20
21    if ($ch === false) {
22        // 初期化に失敗した場合はエラーを記録し、falseを返します
23        error_log('cURL の初期化に失敗しました。');
24        return false;
25    }
26
27    // cURL オプションをまとめて設定します
28    curl_setopt_array($ch, [
29        CURLOPT_URL            => $url,                     // ターゲットURL
30        CURLOPT_RETURNTRANSFER => true,                     // 転送結果を文字列として返す（ブラウザに出力しない）
31        CURLOPT_HEADER         => true,                     // レスポンスヘッダーも転送結果に含める（キーワード `curlopt_header` に関連）
32        CURLOPT_HTTP09_ALLOWED => true,                     // HTTP/0.9 リクエストを許可する（定数 `CURLOPT_HTTP09_ALLOWED` に関連）
33        CURLOPT_TIMEOUT        => 30,                       // 最大実行時間（秒）
34        CURLOPT_FOLLOWLOCATION => true,                     // リダイレクトを自動的に追跡する
35        // テスト目的でSSL検証を無効にするオプション（本番環境では`true`を推奨）
36        CURLOPT_SSL_VERIFYPEER => false,
37        CURLOPT_SSL_VERIFYHOST => false,
38    ]);
39
40    // cURL セッションを実行し、結果を取得します
41    $response = curl_exec($ch);
42
43    if ($response === false) {
44        // 実行中にエラーが発生した場合はエラーを記録し、falseを返します
45        error_log('cURL リクエストエラー: ' . curl_error($ch));
46        curl_close($ch); // セッションを閉じます
47        return false;
48    }
49
50    // レスポンスからヘッダーサイズを取得し、ヘッダーとボディを分離します
51    $headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
52    $header = substr($response, 0, $headerSize);
53    $body = substr($response, $headerSize);
54
55    curl_close($ch); // cURL セッションを閉じます
56
57    // ヘッダーとボディを連想配列として返します
58    return ['header' => $header, 'body' => $body];
59}
60
61// --- 以下はサンプル関数の実行例です ---
62// このコードを直接実行することで、関数の動作を確認できます。
63// 実際のウェブサイトURLを使用していますが、外部へのHTTPリクエストはネットワーク環境に依存します。
64$targetUrl = 'https://example.com'; // 例として、実際のウェブサイトURLを使用
65
66echo "ターゲットURL: " . $targetUrl . "\n\n";
67
68$result = fetchUrlWithCurlOptions($targetUrl);
69
70if ($result !== false) {
71    echo "--- HTTP ヘッダー ---\n";
72    echo $result['header'];
73    echo "\n--- HTTP ボディ (最初の200文字を抜粋) ---\n";
74    echo substr($result['body'], 0, 200) . "...\n"; // ボディの一部を表示
75} else {
76    echo "エラー: URLの取得に失敗しました。\n";
77}
78

このPHPサンプルコードは、cURL拡張機能を利用して指定されたURLへHTTPリクエストを送信し、そのウェブページのヘッダーとボディの情報を取得する方法を示しています。fetchUrlWithCurlOptions関数は、ターゲットURLを引数に受け取り、リクエストが成功した場合はHTTPヘッダーとボディを連想配列で、失敗した場合はfalseを返します。

特に、リファレンス情報で示されたCURLOPT_HTTP09_ALLOWEDオプションは、HTTP/0.9という古いバージョンのHTTPプロトコルでのリクエストを許可する設定です。また、キーワードに関連するCURLOPT_HEADERオプションをtrueに設定することで、サーバーからの応答にHTTPヘッダー情報を含めるように指定し、レスポンスからヘッダーとボディを正確に分離して取得できるようにしています。

その他にも、CURLOPT_URLでリクエスト先のURLを指定したり、CURLOPT_RETURNTRANSFERで転送結果を文字列として返す設定、リダイレクトを自動で追跡するCURLOPT_FOLLOWLOCATIONなど、ウェブコンテンツを取得する際に頻繁に利用される基本的なcURLオプションも含まれています。このコードを通じて、PHPで外部のウェブサイトコンテンツをプログラム的に取得する際の基本的な流れと、HTTP通信の詳細な設定方法を学ぶことができます。