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

Copy
1<?php
2
3/**
4 * 指定されたURLに application/x-www-form-urlencoded 形式でPOSTリクエストを送信します。
5 *
6 * @param string $url POSTリクエストの送信先URL
7 * @param array $data 送信するPOSTデータ（連想配列）
8 * @return string|false 成功した場合はレスポンス本文、失敗した場合はfalse
9 */
10function sendXWwwFormUrlencodedPostRequest(string $url, array $data)
11{
12    // cURLセッションを初期化
13    $ch = curl_init();
14
15    if ($ch === false) {
16        error_log('cURLセッションの初期化に失敗しました。');
17        return false;
18    }
19
20    // cURLオプションを設定
21    curl_setopt($ch, CURLOPT_URL, $url);
22    curl_setopt($ch, CURLOPT_POST, true); // POSTリクエストであることを指定
23    
24    // CURLOPT_POSTFIELDS に連想配列を渡すと、cURLが自動的に
25    // application/x-www-form-urlencoded 形式にエンコードします。
26    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
27    
28    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // 実行結果を文字列として取得
29
30    // リクエストを実行
31    $response = curl_exec($ch);
32
33    // エラーチェック
34    if (curl_errno($ch)) {
35        $error_msg = curl_error($ch);
36        error_log("cURLリクエストエラー: {$error_msg}");
37        curl_close($ch);
38        // リファレンス情報の CURLPX_REQUEST_FAILED は、標準のPHP cURL拡張には存在しませんが、
39        // ここでの curl_errno() によるエラー検出が、リクエスト失敗の役割に相当します。
40        return false;
41    }
42
43    // cURLセッションを閉じる
44    curl_close($ch);
45
46    return $response;
47}
48
49// --- サンプル使用例（このファイルを直接実行して動作を確認できます） ---
50
51// テスト用のPOSTエコーサービスURL
52// このURLは送信されたPOSTデータをJSON形式で返します。
53$targetUrl = 'https://httpbin.org/post'; 
54
55// 送信するPOSTデータ（連想配列）
56$postData = [
57    'username' => 'sampleuser',
58    'password' => 'securepass123',
59    'message' => 'PHPからこんにちは！',
60    'lang' => 'ja',
61];
62
63echo "POSTリクエストを送信中: {$targetUrl}\n";
64echo "送信データ:\n";
65print_r($postData);
66
67// 関数を呼び出してリクエストを送信
68$result = sendXWwwFormUrlencodedPostRequest($targetUrl, $postData);
69
70if ($result !== false) {
71    echo "\nリクエスト成功！レスポンス:\n";
72    echo $result . "\n"; // 取得したレスポンスを表示
73} else {
74    echo "\nリクエスト失敗。詳細についてはエラーログを確認してください。\n";
75}
76
77?>

このPHPサンプルコードは、application/x-www-form-urlencoded形式でPOSTリクエストを送信するsendXWwwFormUrlencodedPostRequest関数を提供しています。この関数は、Webフォームのデータ送信などによく使われるこの形式で、指定されたURLにデータを安全に送る方法を示します。

まず、curl_init()でcURLセッションを開始し、curl_setopt()を使ってリクエストの様々な設定を行います。CURLOPT_URLで送信先のURL、CURLOPT_POSTをtrueに設定してPOSTリクエストであることを指定します。特にCURLOPT_POSTFIELDSに連想配列形式のデータを渡すことで、cURLは自動的にapplication/x-www-form-urlencoded形式にエンコードして送信してくれます。CURLOPT_RETURNTRANSFERをtrueに設定すると、リクエストの実行結果が文字列として返されるようになります。

リクエストの実行はcurl_exec()で行われ、その後curl_errno()によってエラーが発生していないかを確認します。もしエラーが発生した場合、これはCURLPX_REQUEST_FAILEDが示す「リクエストの失敗」の概念に相当し、関数はfalseを返します。成功時にはレスポンス本文が返され、最後にcurl_close()でcURLセッションを終了します。

引数$urlにはPOSTリクエストの送信先URL、$dataには連想配列形式で送りたいPOSTデータを指定します。戻り値は、リクエストが成功した場合はレスポンス本文の文字列、失敗した場合はfalseとなります。

Copy
1<?php
2
3/**
4 * 指定されたURLにカスタムHTTPヘッダー付きでGETリクエストを送信する関数。
5 * CURLリクエストの失敗を適切に処理し、エラーが発生した場合はその詳細をログに出力します。
6 *
7 * @param string $url リクエストを送信するターゲットURL。
8 * @param array $headers オプションのカスタムHTTPヘッダーの配列 (例: ['Content-Type: application/json'])。
9 * @return string|false 成功した場合はレスポンス本文、CURLリクエストが失敗した場合はfalse。
10 */
11function makeCurlRequestWithCustomHeaders(string $url, array $headers = []): string|false
12{
13    // 1. CURLセッションを初期化します。
14    $ch = curl_init();
15
16    // CURLの初期化に失敗した場合の処理。
17    // PHPのCURL拡張機能がロードされていないなどの深刻なエラー時に発生します。
18    if ($ch === false) {
19        error_log("CURLセッションの初期化に失敗しました。PHPのCURL拡張機能が正しく設定されているか確認してください。");
20        // リファレンス情報にある CURLPX_REQUEST_FAILED のような致命的なエラーとして扱えます。
21        return false;
22    }
23
24    // 2. CURLオプションを設定します。
25
26    // リクエストを送信するURLを設定します。
27    curl_setopt($ch, CURLOPT_URL, $url);
28
29    // レスポンスを文字列として取得する設定。
30    // これがないと、curl_exec() は直接出力します。
31    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
32
33    // レスポンスヘッダーを結果に含めない設定（レスポンス本文のみを取得）。
34    curl_setopt($ch, CURLOPT_HEADER, false);
35
36    // カスタムHTTPヘッダーが指定されている場合、設定します。
37    // ここがキーワード「request header」に関連する重要な部分です。
38    if (!empty($headers)) {
39        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
40    }
41
42    // 3. CURLリクエストを実行します。
43    $response = curl_exec($ch);
44
45    // 4. リクエストの実行中にエラーが発生したか確認します。
46    if (curl_errno($ch)) {
47        // ここでリファレンス情報にある CURLPX_REQUEST_FAILED のようなリクエスト失敗を検出できます。
48        // (注意: `CURLPX_REQUEST_FAILED` は標準のPHP CURL拡張には存在しない架空の定数です。
49        // PHPの標準CURL拡張では、`curl_errno()` と `curl_error()` を使用してエラーを処理します。)
50        $errorCode = curl_errno($ch);
51        $errorMessage = curl_error($ch);
52        error_log("CURLリクエストが失敗しました。エラーコード: {$errorCode}, メッセージ: {$errorMessage}");
53        curl_close($ch);
54        return false;
55    }
56
57    // 5. CURLセッションを閉じ、リソースを解放します。
58    curl_close($ch);
59
60    return $response;
61}
62
63// --- サンプルコードの利用例 ---
64
65// ターゲットURLを指定します。
66// 例として、インターネット上に存在しないドメインを指定して、CURLリクエスト失敗の動作を確認できます。
67$targetUrl = 'https://non-existent-domain-for-test.com/api/data';
68
69// 実際に動作確認したい場合は、以下のような既存のサービスを利用できます。
70// $targetUrl = 'https://httpbin.org/get'; // HTTP GETリクエストとヘッダーをエコーバックするサービス
71
72// 送信するカスタムHTTPヘッダーを定義します。
73$customHeaders = [
74    'Accept: application/json',
75    'User-Agent: MyPhpApp/1.0 (PHP ' . PHP_VERSION . ')',
76    'X-Custom-Request-ID: ' . uniqid(), // ユニークなIDを付与
77];
78
79echo "指定されたURL '{$targetUrl}' へCURLリクエストを実行します。\n";
80$responseBody = makeCurlRequestWithCustomHeaders($targetUrl, $customHeaders);
81
82if ($responseBody === false) {
83    echo "CURLリクエストが失敗しました。詳細については、サーバーのエラーログを確認してください。\n";
84} else {
85    echo "CURLリクエストが成功しました。レスポンス本文の一部を表示します。\n";
86    // レスポンスが長い場合に備え、最初の500文字のみ表示します。
87    echo substr($responseBody, 0, 500) . (strlen($responseBody) > 500 ? '...' : '') . "\n";
88}

このPHPサンプルコードは、指定されたURLへカスタムHTTPヘッダーを付けてGETリクエストを送信するためのmakeCurlRequestWithCustomHeaders関数を定義しています。システムエンジニアを目指す初心者の方々にとって、外部API連携などで頻繁に利用されるCURL拡張機能の基本と、エラー処理の重要性を理解するのに役立ちます。

関数は$urlでターゲットURLを、オプションの$headers配列で送信したいカスタムHTTPヘッダー（例: ['Content-Type: application/json']）を受け取ります。成功時にはサーバーからのレスポンス本文を文字列として返し、CURLリクエストが失敗した場合はfalseを返します。

内部では、まずcurl_init()でCURLセッションを初期化し、失敗した場合はエラーログを出力して処理を中断します。次に、curl_setopt()関数を用いて、リクエスト先のURL設定、レスポンスを文字列として取得する設定（CURLOPT_RETURNTRANSFER）、そして特に重要なカスタムHTTPヘッダーの設定（CURLOPT_HTTPHEADER）など、必要なCURLオプションを設定しています。このカスタムヘッダーの指定により、リクエスト時に任意の情報をサーバーへ送ることが可能です。

リクエストの実行はcurl_exec()で行われ、その結果、curl_errno()でエラーが発生していないかを確認します。もしエラーがあれば、curl_errno()とcurl_error()を用いてエラーコードとメッセージを取得し、ログに出力してからfalseを返します。これは、リファレンス情報にあるCURLPX_REQUEST_FAILEDのように、リクエストが失敗した状況を検出・処理する一般的な方法です。最後にcurl_close()でセッションを閉じ、リソースを解放します。

サンプルコードの利用例では、存在しないドメインへのリクエストや、実際のサービスへのリクエストを通じて、関数の動作やエラーハンドリングの仕組みを確認できるようにしています。これにより、外部サービスとの連携におけるHTTPリクエストの送信と、その信頼性を高めるエラー処理の基本を学ぶことができます。