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

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツを取得する関数。
5 * cURLのCURLOPT_RETURNTRANSFERオプションとCURLOPT_REQUEST_TARGETオプションの使用例を示します。
6 *
7 * @param string $url 取得するターゲットのURL。
8 * @return string|false 成功した場合は取得したコンテンツ、失敗した場合はfalse。
9 */
10function fetchUrlContent(string $url): string|false
11{
12    // cURLセッションを初期化します。
13    // cURL拡張機能が有効になっている必要があります。
14    $ch = curl_init();
15
16    // cURLセッションの初期化に失敗した場合の処理。
17    if ($ch === false) {
18        error_log("cURLセッションの初期化に失敗しました。");
19        return false;
20    }
21
22    // --- cURLオプションの設定 ---
23
24    // 1. CURLOPT_URL: リクエストを送信するターゲットURLを設定します。
25    curl_setopt($ch, CURLOPT_URL, $url);
26
27    // 2. CURLOPT_RETURNTRANSFER: curl_exec()関数の戻り値を設定します。
28    //    trueに設定すると、リモートサーバーからの応答を文字列として返します。
29    //    false（デフォルト）の場合、応答は直接出力されます。
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
31
32    // 3. CURLOPT_REQUEST_TARGET: HTTPリクエストラインのターゲットパスを明示的に設定します。
33    //    これはPHP 8で追加されたcURLオプションです。
34    //    通常、cURLはCURLOPT_URLからリクエストターゲットを自動的に構築しますが、
35    //    このオプションを使用することで、カスタムのターゲットパスを指定できます。
36    //    ここでは、URLのパス部分とクエリ部分をリクエストターゲットとして設定します。
37    $parsedUrl = parse_url($url);
38    $requestTarget = '/'; // デフォルトのリクエストターゲットパス
39    if ($parsedUrl !== false && isset($parsedUrl['path'])) {
40        $requestTarget = $parsedUrl['path'];
41    }
42    // パスが空だった場合（例: "http://example.com" のようにパスがない場合）
43    if (empty($requestTarget)) {
44        $requestTarget = '/';
45    }
46    // クエリ文字列が存在する場合、リクエストターゲットに結合します。
47    if ($parsedUrl !== false && isset($parsedUrl['query'])) {
48        $requestTarget .= '?' . $parsedUrl['query'];
49    }
50    curl_setopt($ch, CURLOPT_REQUEST_TARGET, $requestTarget);
51
52    // その他の一般的なcURLオプション (任意)
53    // リダイレクトを自動的に追跡します。
54    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
55    // User-Agentヘッダーを設定します。多くのウェブサイトで推奨されます。
56    curl_setopt($ch, CURLOPT_USERAGENT, 'PHP cURL Client/1.0');
57    // 接続のタイムアウトを設定します（秒）。
58    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
59    // 実行のタイムアウトを設定します（秒）。
60    curl_setopt($ch, CURLOPT_TIMEOUT, 30);
61    
62    // HTTPSサイトでSSL証明書の検証をスキップする場合（開発環境でのみ推奨）
63    // 本番環境ではセキュリティ上の理由から推奨されません。
64    // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
65    // curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
66
67
68    // cURLセッションを実行し、設定されたCURLOPT_RETURNTRANSFERに従って結果を取得します。
69    $response = curl_exec($ch);
70
71    // cURL実行中にエラーが発生したかどうかを確認します。
72    if (curl_errno($ch)) {
73        echo 'cURLエラー: ' . curl_error($ch) . "\n";
74        curl_close($ch);
75        return false;
76    }
77
78    // HTTPステータスコードを取得します。
79    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
80
81    // HTTPステータスコードが400以上（クライアントエラーまたはサーバーエラー）の場合の処理。
82    if ($httpCode >= 400) {
83        echo "HTTPエラー: ステータスコード " . $httpCode . "\n";
84        // 必要に応じてレスポンス内容を表示することもできます。
85        // echo "レスポンス:\n" . $response . "\n";
86    }
87
88    // cURLセッションを閉じ、リソースを解放します。
89    curl_close($ch);
90
91    // 取得したコンテンツを返します。
92    return $response;
93}
94
95// --- サンプル使用例 ---
96// 実際にコンテンツを取得するURLを指定してください。
97$targetUrl = 'https://example.com/'; 
98echo "URL: " . $targetUrl . " からコンテンツを取得中...\n";
99
100// fetchUrlContent関数を呼び出してコンテンツを取得します。
101$content = fetchUrlContent($targetUrl);
102
103// 取得が成功したか失敗したかに基づいて結果を表示します。
104if ($content !== false) {
105    echo "コンテンツの一部:\n";
106    // 取得したコンテンツの最初の500文字のみ表示します。
107    echo mb_strcut($content, 0, 500) . "...\n"; 
108    echo "コンテンツ取得完了。\n";
109} else {
110    echo "コンテンツの取得に失敗しました。\n";
111}
112
113?>

このPHPサンプルコードは、cURL拡張機能を用いて指定されたURLからウェブコンテンツを取得する基本的な方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。特にCURLOPT_REQUEST_TARGETとCURLOPT_RETURNTRANSFERという二つの重要なcURLオプションの使い方に焦点を当てています。

CURLOPT_RETURNTRANSFERオプションをtrueに設定すると、curl_exec()関数がリモートサーバーから取得した応答内容を文字列として関数の戻り値で返します。デフォルトでは応答が直接出力されるため、プログラム内でコンテンツを加工したい場合にこのオプションは必須です。

CURLOPT_REQUEST_TARGETはPHP 8で導入されたオプションで、HTTPリクエストラインにおいてサーバーに送信されるターゲットパスを明示的に指定できます。通常、cURLはCURLOPT_URLで指定されたURLからターゲットパスを自動的に構築しますが、このオプションを使用することで、開発者が意図するカスタムのパス（例：URLのパスとクエリ部分）を正確に設定することが可能になります。サンプルコードでは、parse_url()関数を使ってURLのパスとクエリ部分を抽出し、それらを組み合わせてリクエストターゲットとして設定しています。

コード全体の流れとしては、まずcurl_init()でcURLセッションを初期化し、curl_setopt()で取得対象のURLや先述のオプション、リダイレクト追跡、タイムアウトなどの詳細な設定を行います。その後curl_exec()でリクエストを実行し、応答を取得します。エラーが発生した場合はcurl_errno()でエラー情報を確認し、curl_getinfo()でHTTPステータスコードをチェックすることで、通信状況を把握できます。最後にcurl_close()でセッションを閉じ、取得したコンテンツを返します。

関数fetchUrlContentは、引数として取得したいURL（string型）を受け取り、成功した場合は取得したウェブコンテンツをstring型で、失敗した場合はfalseを戻り値として返します。

Copy
1<?php
2
3/**
4 * カスタムHTTPメソッドで cURL リクエストを送信するサンプル関数。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * RESTful APIなどで利用されるGET/POST以外のHTTPメソッド (例: PUT, DELETE) を
8 * PHPのcURL拡張機能で送信する方法を示します。
9 *
10 * @param string $url リクエストを送信するターゲットURL。
11 * @param string $method 使用するカスタムHTTPメソッド (例: 'PUT', 'DELETE', 'PATCH'など)。
12 * @param array $data リクエストボディとして送信するデータ。通常はPUT/POST/PATCHで使用します。
13 * @return string|false 成功した場合はサーバーからのレスポンスボディ、失敗した場合は false。
14 */
15function sendCustomHttpRequest(string $url, string $method, array $data = []): string|false
16{
17    // cURL ハンドルを初期化します。
18    // これが失敗した場合は false を返します。
19    $ch = curl_init();
20    if ($ch === false) {
21        error_log("cURL の初期化に失敗しました。");
22        return false;
23    }
24
25    // cURL オプションを設定します。
26    // CURLOPT_URL: リクエストの送信先URLを設定します。
27    curl_setopt($ch, CURLOPT_URL, $url);
28
29    // CURLOPT_RETURNTRANSFER: 実行結果を文字列として返すように設定します。
30    // これを設定しない場合、結果は直接出力されます。
31    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
32
33    // CURLOPT_HEADER: レスポンスヘッダーを結果に含めないように設定します。
34    curl_setopt($ch, CURLOPT_HEADER, false);
35
36    // CURLOPT_CUSTOMREQUEST: GETやPOST以外のHTTPメソッドを指定します。
37    // 例えば、リソースの更新には 'PUT'、削除には 'DELETE' を使用します。
38    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, strtoupper($method));
39
40    // 送信するデータ (リクエストボディ) がある場合の設定
41    if (!empty($data)) {
42        $jsonData = json_encode($data);
43        if ($jsonData === false) {
44            error_log("データのJSONエンコードに失敗しました。");
45            curl_close($ch);
46            return false;
47        }
48
49        // CURLOPT_POSTFIELDS: POST、PUTなどのリクエストボディに含めるデータを設定します。
50        curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
51
52        // Content-Type ヘッダー: 送信するデータの形式をサーバーに伝えます。
53        // JSONデータを送信する場合は 'application/json' を指定します。
54        curl_setopt($ch, CURLOPT_HTTPHEADER, [
55            'Content-Type: application/json',
56            'Content-Length: ' . strlen($jsonData) // Content-Length ヘッダーも設定
57        ]);
58    }
59
60    // cURL リクエストを実行し、サーバーからのレスポンスを取得します。
61    $response = curl_exec($ch);
62
63    // cURL 実行中にエラーが発生したかを確認します。
64    if (curl_errno($ch)) {
65        $errorMsg = curl_error($ch);
66        error_log("cURL エラーが発生しました: " . $errorMsg);
67        $response = false; // エラー時は false を返します。
68    }
69
70    // cURL ハンドルを閉じ、リソースを解放します。
71    curl_close($ch);
72
73    return $response;
74}
75
76// --- サンプルコードの実行例 ---
77// 以下のURLは、ダミーのAPIを提供しているサービス (JSONPlaceholder) のものです。
78// 実際にリクエストが送信され、結果を確認できます。
79
80// 例1: PUTメソッドで既存のリソースを更新する
81echo "--- PUT リクエストの実行例 (リソース更新) ---\n";
82$putUrl = 'https://jsonplaceholder.typicode.com/posts/1';
83$putData = [
84    'id' => 1,
85    'title' => '更新されたタイトル',
86    'body' => 'これはPUTメソッドで更新されたボディです。',
87    'userId' => 1
88];
89$putResponse = sendCustomHttpRequest($putUrl, 'PUT', $putData);
90
91if ($putResponse !== false) {
92    echo "PUT リクエスト成功:\n";
93    echo $putResponse . "\n"; // 更新されたリソースの情報が出力されます
94} else {
95    echo "PUT リクエスト失敗。\n";
96}
97echo "\n";
98
99// 例2: DELETEメソッドで既存のリソースを削除する
100echo "--- DELETE リクエストの実行例 (リソース削除) ---\n";
101$deleteUrl = 'https://jsonplaceholder.typicode.com/posts/1';
102// DELETEメソッドは通常、リクエストボディを必要としないため、$dataは空のままです。
103$deleteResponse = sendCustomHttpRequest($deleteUrl, 'DELETE');
104
105if ($deleteResponse !== false) {
106    echo "DELETE リクエスト成功:\n";
107    echo $deleteResponse . "\n"; // 空のオブジェクト {} が返されることが多いです
108} else {
109    echo "DELETE リクエスト失敗。\n";
110}
111
112?>

このPHPのサンプルコードは、PHPのcURL拡張機能を用いて、GETやPOST以外のカスタムHTTPメソッド（PUT、DELETEなど）でリクエストを送信する方法を、システムエンジニアを目指す初心者向けに示しています。RESTful APIなどでのデータ更新や削除によく利用される技術です。

sendCustomHttpRequest関数は、指定されたURLに対し、指定のHTTPメソッドとデータでリクエストを送ります。重要なのはCURLOPT_CUSTOMREQUESTオプションで、ここに'PUT'や'DELETE'といったメソッド名を指定することで、標準的なHTTPリクエスト以外の操作が可能になります。CURLOPT_URLで送信先を設定し、CURLOPT_RETURNTRANSFERを有効にすることで、サーバーからの応答を文字列として関数の戻り値で受け取ります。データがある場合はjson_encodeでJSON形式に変換し、CURLOPT_POSTFIELDSでリクエストボディに含め、Content-Type: application/jsonヘッダーも設定しています。リクエスト実行後はcurl_closeでリソースを解放します。

引数$urlはリクエストの送信先URL（文字列）、$methodは使用するHTTPメソッド名（例: 'PUT', 'DELETE'など、文字列）、$dataはリクエストボディに含めるデータ（連想配列）です。戻り値は、成功時にはサーバーからのレスポンスボディ（文字列）、失敗時にはfalseを返します。サンプルコードの後半では、PUTメソッドでのリソース更新やDELETEメソッドでのリソース削除の実行例を確認できます。