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

Copy
1<?php
2
3/**
4 * cURL を使用して指定されたURLにHTTP GETリクエストを実行します。
5 * システムエンジニアを目指す初心者向けに、基本的な cURL オプションの設定とエラーハンドリングを示します。
6 *
7 * @param string $url リクエストを送信するURL。
8 * @return string|false 成功時はレスポンスボディ、失敗時はfalse。
9 */
10function performSimpleCurlGetRequest(string $url)
11{
12    // 1. cURLセッションを初期化
13    // 新しい cURL セッションを開始し、そのハンドルを返します。
14    $ch = curl_init();
15
16    // 2. cURLオプションを設定 (curl_setopt)
17    // curl_setopt() を使用して、HTTPリクエストの動作を詳細に制御します。
18    // これらの定数 (CURLOPT_XXX) は PHP の cURL 拡張によって提供されます。
19
20    // CURLOPT_URL: リクエストを送信するターゲットURLを指定します。
21    curl_setopt($ch, CURLOPT_URL, $url);
22
23    // CURLOPT_RETURNTRANSFER: curl_exec() の結果を文字列として返すように設定します。
24    // true にしない場合、レスポンスは直接出力されます。
25    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
26
27    // CURLOPT_TIMEOUT: cURL 操作全体の最大許容時間を秒単位で設定します。
28    // これにより、応答がない場合にプログラムが無限に待機するのを防ぎます。
29    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
30
31    // CURLOPT_FOLLOWLOCATION: HTTP Location ヘッダーに従ってリダイレクトを自動的に処理します。
32    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
33
34    // CURLOPT_MAXREDIRS: CURLOPT_FOLLOWLOCATION が true の場合、
35    // たどるリダイレクトの最大数を設定し、無限リダイレクトを防ぎます。
36    curl_setopt($ch, CURLOPT_MAXREDIRS, 3);
37
38    // 注意: リファレンスで指定された CURLPX_REPLY_ADDRESS_TYPE_NOT_SUPPORTED 定数は、
39    // PHP の標準 cURL 拡張には存在しません。このコードでは、PHP に存在する標準の
40    // CURLOPT_XXX 定数のみを使用し、一般的な cURL リクエストのパターンを示します。
41    // もしこの定数が特定の環境やライブラリで定義されている場合、通常はエラーコード
42    // の比較などに利用されることが考えられますが、このサンプルでは直接扱いません。
43
44
45    // 3. リクエストを実行
46    // 設定されたオプションに基づいて cURL セッションを実行します。
47    $response = curl_exec($ch);
48
49    // 4. エラーチェック
50    // curl_errno() は直近の cURL 操作のエラー番号を返します。0 はエラーがないことを意味します。
51    if (curl_errno($ch)) {
52        $error_message = curl_error($ch); // curl_error() はエラー内容を文字列で返します。
53        error_log("cURL Error for '{$url}': " . $error_message);
54        curl_close($ch); // エラーが発生した場合はセッションを閉じて終了
55        return false;
56    }
57
58    // HTTP ステータスコードのチェック
59    // curl_getinfo() を使用して、転送に関する情報を取得します。
60    // CURLINFO_HTTP_CODE は、HTTP ステータスコード (例: 200 OK, 404 Not Found) を返します。
61    $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
62    if ($http_code >= 400) {
63        error_log("HTTP Status Error for '{$url}': " . $http_code);
64        curl_close($ch);
65        return false;
66    }
67
68    // 5. cURLセッションを閉じる
69    // cURL セッションを閉じ、関連するすべてのリソースを解放します。
70    curl_close($ch);
71
72    return $response;
73}
74
75// ----- 関数の使用例 -----
76// このスクリプトを単体で実行すると、以下のコードが実行され、結果が出力されます。
77
78$targetUrl = "https://www.example.com"; // アクセス可能なURLの例
79
80// 実際にリクエストを実行
81$fetchedContent = performSimpleCurlGetRequest($targetUrl);
82
83if ($fetchedContent !== false) {
84    echo "URL: {$targetUrl} からのコンテンツ取得に成功しました。\n";
85    echo "コンテンツの冒頭200文字:\n";
86    echo substr($fetchedContent, 0, 200) . "...\n";
87} else {
88    echo "URL: {$targetUrl} からのコンテンツ取得に失敗しました。エラーログを確認してください。\n";
89}
90
91// エラーハンドリングの例 (存在しないURLを試す場合)
92// $nonExistentUrl = "http://localhost:9999";
93// echo "\n--- 存在しないURLでのテスト ---\n";
94// $failedContent = performSimpleCurlGetRequest($nonExistentUrl);
95// if ($failedContent === false) {
96//     echo "URL: {$nonExistentUrl} からのコンテンツ取得は意図通り失敗しました。\n";
97// }

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたURLへHTTP GETリクエストを送信する基本的な方法を、システムエンジニアを目指す初心者向けに示しています。まず、curl_init()でcURLセッションを初期化し、curl_setopt()関数でリクエストの挙動を詳細に設定します。例えば、CURLOPT_URLでアクセス先のURLを設定し、CURLOPT_RETURNTRANSFERでcurl_exec()の戻り値が直接出力されるのではなく文字列として返されるように指定します。また、CURLOPT_TIMEOUTで最大実行時間を設定し、CURLOPT_FOLLOWLOCATIONとCURLOPT_MAXREDIRSでリダイレクト処理を行います。

提供されたリファレンス情報にあるCURLPX_REPLY_ADDRESS_TYPE_NOT_SUPPORTED定数は、PHPの標準cURL拡張には存在しません。この定数は、もし特定の環境やライブラリで定義されている場合、通常はエラーコードの比較などに利用されるものと推測されますが、このサンプルコードでは、PHPに標準で存在するCURLOPT_XXX定数のみを用いて一般的なリクエストパターンを紹介しています。

設定後、curl_exec()でリクエストを実行し、curl_errno()やcurl_getinfo(CURLINFO_HTTP_CODE)を使ってエラーが発生していないか、HTTPステータスコードが成功を示しているかを確認します。エラーが発生した場合やHTTPステータスコードが問題を示す場合は、error_log()でログに出力します。最後にcurl_close()でcURLセッションを閉じ、リソースを解放します。

performSimpleCurlGetRequest関数は、リクエストを送信するURLを$url（文字列）として受け取り、リクエストが成功した場合は取得したコンテンツの文字列を、失敗した場合はfalseを戻り値として返します。

Copy
1<?php
2
3/**
4 * 指定されたURLにPOSTリクエストを送信し、その結果を返します。
5 *
6 * この関数は、PHPのcURL拡張機能を使用してHTTP POSTリクエストを構築・送信します。
7 * システムエンジニアを目指す初心者の方が、外部APIなどへデータを送信する際の
8 * 基本的な方法を理解するのに役立ちます。
9 *
10 * @param string $url POSTリクエストを送信するURL。例: 'https://example.com/api/create'
11 * @param array $data POSTするデータ（キーと値のペアの配列）。例: ['name' => 'Alice', 'age' => 30]
12 * @return string|false リクエストが成功した場合はレスポンスの文字列、失敗した場合はfalse。
13 */
14function sendPostRequest(string $url, array $data): string|false
15{
16    // 1. cURLセッションを初期化します。
17    // curl_init() は新しいcURLセッションを開始し、そのハンドルを返します。
18    // 失敗した場合は false を返します。
19    $ch = curl_init();
20
21    // cURLの初期化に失敗した場合の処理
22    if ($ch === false) {
23        error_log('cURLセッションの初期化に失敗しました。');
24        return false;
25    }
26
27    // 2. cURLオプションを設定します。
28    // curl_setopt() を使用して、cURLセッションの挙動をカスタマイズします。
29
30    // リクエストを送信するURLを設定します。
31    curl_setopt($ch, CURLOPT_URL, $url);
32
33    // POSTリクエストであることをcURLに伝えます。
34    // trueに設定することで、HTTPメソッドがPOSTになります。
35    curl_setopt($ch, CURLOPT_POST, true);
36
37    // POSTするデータを設定します。
38    // ここで配列を渡すと、cURLが自動的に 'application/x-www-form-urlencoded' 形式に
39    // 変換してリクエストボディに含めます。
40    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
41
42    // curl_exec() の実行結果を直接出力するのではなく、文字列として返すようにします。
43    // これにより、取得したレスポンスを変数に格納して処理できます。
44    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
45
46    // オプション: タイムアウトを10秒に設定します。
47    // 指定した時間内にサーバーからの応答がない場合、リクエストを中止します。
48    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
49
50    // オプション: HTTPステータスコードが400以上の場合にエラーとして扱います。
51    // これを設定すると、エラー時に curl_exec() が false を返し、
52    // curl_errno() や curl_error() で詳細を確認できるようになります。
53    curl_setopt($ch, CURLOPT_FAILONERROR, true);
54
55    // 3. cURLセッションを実行し、レスポンスを取得します。
56    // 成功した場合はレスポンスデータが文字列で返され、失敗した場合は false が返されます。
57    $response = curl_exec($ch);
58
59    // 4. エラーが発生したかを確認します。
60    if ($response === false) {
61        // curl_errno() でエラーコード、curl_error() でエラーメッセージを取得できます。
62        $errorNo = curl_errno($ch);
63        $errorMsg = curl_error($ch);
64        error_log("cURLリクエスト中にエラーが発生しました ({$errorNo}): {$errorMsg}");
65        // セッションを閉じてから false を返します。
66        curl_close($ch);
67        return false;
68    }
69
70    // 5. cURLセッションを閉じます。
71    // curl_close() はcURLセッションで使用したリソースを解放します。
72    curl_close($ch);
73
74    // 6. 取得したレスポンスを返します。
75    return $response;
76}
77
78// -----------------------------------------------------------------------------
79// サンプルコードの使用例
80// -----------------------------------------------------------------------------
81
82// 注意: 実際のAPIエンドポイントに置き換えてください。
83// この例では、公開されているダミーAPIサービス (JSONPlaceholder) を使用しています。
84$targetUrl = 'https://jsonplaceholder.typicode.com/posts';
85
86// POSTで送信するデータ
87$postData = [
88    'title' => '私の初めての投稿',
89    'body' => 'PHPのcURLで送信したテスト投稿です。',
90    'userId' => 101, // ユーザーIDを想定
91];
92
93echo "=== POSTリクエストの送信 ===\n";
94echo "送信先URL: {$targetUrl}\n";
95echo "送信データ:\n" . json_encode($postData, JSON_PRETTY_PRINT) . "\n\n";
96
97// sendPostRequest 関数を呼び出してリクエストを送信します。
98$result = sendPostRequest($targetUrl, $postData);
99
100// 結果の表示
101if ($result !== false) {
102    echo "--- リクエスト成功 ---\n";
103    echo "サーバーからのレスポンス:\n";
104    // 取得したレスポンスは通常JSON形式であるため、整形して表示すると見やすいです。
105    $decodedResponse = json_decode($result, true);
106    if (json_last_error() === JSON_ERROR_NONE) {
107        echo json_encode($decodedResponse, JSON_PRETTY_PRINT) . "\n";
108    } else {
109        echo $result . "\n"; // JSONでなければそのまま表示
110    }
111} else {
112    echo "--- リクエスト失敗 ---\n";
113    echo "詳細については、PHPのエラーログを確認してください。\n";
114}
115
116?>

PHPのcURL拡張機能は、プログラムからHTTPリクエストを送信するための強力な機能です。提示されたサンプルコードは、システムエンジニアを目指す初心者の方が、外部のWebサービスやAPIに対してデータを送信する「POSTリクエスト」を行う基本的な手順を簡潔に示しています。

このコードでは、sendPostRequest関数が指定されたURLに配列形式のデータをPOSTリクエストとして送信します。まずcurl_init()でcURLセッションを開始し、次にcurl_setopt()を使って様々な設定を行います。具体的には、リクエスト先のURL（CURLOPT_URL）、POSTメソッドの有効化（CURLOPT_POST）、送信したいデータ（CURLOPT_POSTFIELDS）、そしてサーバーからのレスポンスを直接出力せず文字列として受け取る設定（CURLOPT_RETURNTRANSFER）などが含まれます。

設定が完了すると、curl_exec()関数が実際にリクエストを実行し、サーバーからの応答を取得します。リクエスト中にエラーが発生した場合は、curl_errno()やcurl_error()で詳細なエラー情報を取得し、ログに出力する仕組みも備わっています。最終的に、curl_close()でセッションのリソースを解放します。

関数の引数$urlはPOSTリクエストを送信する対象のURLを文字列で指定し、$dataはPOSTするデータをキーと値のペアで構成される配列として指定します。戻り値は、リクエストが成功した場合はサーバーからのレスポンスが文字列として返され、失敗した場合はfalseが返されるため、呼び出し側で成功・失敗を判断し、適切な処理を行うことができます。