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

Copy
1<?php
2
3/**
4 * HTTP POSTリクエストをcURLを使用して送信するサンプル関数。
5 *
6 * この関数は、指定されたURLにPOSTデータを送信し、サーバーからのレスポンスを返します。
7 * システムエンジニアを目指す初心者向けに、CURLOPT_POSTFIELDSとCURLOPT_PORTの
8 * 基本的な使用方法を含んだ正確で簡潔なサンプルコードを提供します。
9 *
10 * @param string $url リクエストを送信するURL。
11 * @param array $data 送信するPOSTデータの連想配列。
12 * @return string|false 成功した場合はレスポンス本文、失敗した場合はfalse。
13 */
14function sendHttpPostRequestWithCurl(string $url, array $data)
15{
16    // cURLセッションを初期化します。
17    // cURLは様々なプロトコルでネットワーク通信を行うためのライブラリです。
18    $ch = curl_init();
19
20    // cURLセッションの初期化に失敗した場合はエラーを記録し、falseを返します。
21    if ($ch === false) {
22        error_log('cURLセッションの初期化に失敗しました。');
23        return false;
24    }
25
26    // POSTデータをHTTPクエリ文字列形式（例: key1=value1&key2=value2）に変換します。
27    // CURLOPT_POSTFIELDSに配列を直接渡すこともできますが、
28    // この形式が一般的で初心者にも分かりやすいです。
29    $postFields = http_build_query($data);
30
31    // cURLオプションをまとめて設定します。
32    curl_setopt_array($ch, [
33        CURLOPT_URL            => $url,                          // リクエストを送信するターゲットURLを設定します。
34        CURLOPT_POST           => true,                          // HTTP POSTメソッドを使用することを指定します。
35        CURLOPT_POSTFIELDS     => $postFields,                   // 送信するPOSTデータを設定します。(キーワード: CURLOPT_POSTFIELDS)
36        CURLOPT_RETURNTRANSFER => true,                          // curl_exec()がレスポンス文字列を返すように設定します。
37                                                                 // これをtrueにしない場合、レスポンスは直接出力されます。
38        CURLOPT_HEADER         => false,                         // レスポンスヘッダーを結果に含めないように設定します。
39        CURLOPT_TIMEOUT        => 30,                            // リクエストの最大実行時間を秒単位で設定します。
40        CURLOPT_FAILONERROR    => true,                          // HTTPステータスコードが400以上の場合にエラーを返します。
41
42        // CURLOPT_PORT の使用例 (リファレンス情報: CURLOPT_PORT)
43        // このオプションは、ターゲットサーバーがデフォルトとは異なるポートでリッスンしている場合に
44        // 明示的にポート番号を指定するために使用します。
45        // 例ではHTTPSの標準ポート443を指定していますが、通常はURLスキーム（https://）から自動判別されるため、
46        // 明示的な指定は稀で、特に必要がない限り省略されます。
47        CURLOPT_PORT           => 443,
48
49        // HTTPS (SSL/TLS) を使用するURLの場合、サーバー証明書の検証に関する設定を行います。
50        // これらは通信のセキュリティを確保するために重要です。
51        CURLOPT_SSL_VERIFYPEER => true,                          // ピアのSSL証明書を検証します。本番環境では必須です。
52        CURLOPT_SSL_VERIFYHOST => 2,                             // ホスト名の検証を行います (PHP 8では推奨値2)。
53    ]);
54
55    // 設定されたオプションでHTTPリクエストを実行し、レスポンスを取得します。
56    $response = curl_exec($ch);
57
58    // リクエストの実行中にエラーが発生したかを確認します。
59    if ($response === false) {
60        $errorNo  = curl_errno($ch);  // エラーコードを取得
61        $errorMsg = curl_error($ch);  // エラーメッセージを取得
62        error_log("cURLエラー ({$errorNo}): {$errorMsg}"); // エラーをログに記録
63        curl_close($ch); // エラーの場合もcURLセッションを閉じます。
64        return false;
65    }
66
67    // cURLセッションを閉じ、使用したリソースを解放します。
68    curl_close($ch);
69
70    // 成功した場合はレスポンス本文を返します。
71    return $response;
72}
73
74// --- 以下はサンプル関数の使用例です ---
75
76// テスト用のPOSTリクエストを受け付けるダミーAPIのURL
77// (JSONPlaceholderは、GET/POST/PUT/DELETEリクエストを試すことができる無料のREST APIです)
78$targetUrl = 'https://jsonplaceholder.typicode.com/posts';
79
80// 送信するPOSTデータ (連想配列形式)
81$postData = [
82    'title' => 'foo bar baz',
83    'body'  => 'This is a sample post body for testing purposes.',
84    'userId' => 101,
85];
86
87echo "Sending POST request to: " . $targetUrl . PHP_EOL;
88echo "With data: " . json_encode($postData, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) . PHP_EOL . PHP_EOL;
89
90// 関数を呼び出してPOSTリクエストを送信します。
91$result = sendHttpPostRequestWithCurl($targetUrl, $postData);
92
93// 結果を表示します。
94if ($result !== false) {
95    echo "--- Response received ---" . PHP_EOL;
96    echo $result . PHP_EOL;
97    echo "--------------------------" . PHP_EOL;
98} else {
99    echo "--- Failed to send POST request ---" . PHP_EOL;
100}

このPHPサンプルコードは、cURLライブラリを用いてHTTP POSTリクエストを送信する基本的な方法を示しています。sendHttpPostRequestWithCurl関数は、指定されたURLへ連想配列形式のデータをPOSTし、サーバーからのレスポンスを文字列で受け取るためのものです。引数として、リクエストを送信する$url（文字列）と、送信したい$data（配列）を受け取ります。処理に成功した場合、関数の戻り値はサーバーからのレスポンス本文（文字列）となり、失敗した場合はfalseを返します。

コード内では、まずcurl_init()でcURLセッションを初期化し、curl_setopt_array()で様々なオプションを設定しています。特に、CURLOPT_POSTFIELDSオプションは、HTTP POSTリクエストでサーバーに送信するデータを指定するために使用されます。サンプルでは、http_build_query()関数を使って配列データをHTTPクエリ文字列形式に変換してから設定しています。また、CURLOPT_PORTオプションは、ターゲットサーバーがデフォルト以外のポートでリッスンしている場合に、明示的にポート番号を指定する際に利用されます。通常はURLスキームから自動判別されるため省略されますが、ここでは使用例としてHTTPSの標準ポート443が指定されています。

CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果が直接出力されず、関数の戻り値として文字列で取得されます。リクエスト実行後は、エラーが発生していないかを確認し、curl_close()でリソースを適切に解放しています。このサンプルは、PHPで外部システムと連携する際の基本的なネットワーク通信処理を理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * cURLを使ってPOSTリクエストを送信し、ポート番号を明示的に設定するサンプル関数です。
5 *
6 * システムエンジニアを目指す初心者向けに、CURLOPT_POST と CURLOPT_PORT
7 * の基本的な使用方法を簡潔に示します。
8 *
9 * @return string サーバーからのレスポンス、またはエラーメッセージを返します。
10 */
11function performCurlPostRequestWithPort(): string
12{
13    // cURLセッションを初期化します。
14    $ch = curl_init();
15
16    // 接続先のURLを設定します。
17    // httpbin.org は、HTTPリクエストとレスポンスのテストに便利なサービスです。
18    // ここでは、POSTリクエストを受け付けるエンドポイントを使用します。
19    $url = 'https://httpbin.org/post';
20    curl_setopt($ch, CURLOPT_URL, $url);
21
22    // POSTリクエストを有効にします。
23    // これを true に設定することで、HTTPメソッドがPOSTになります。
24    curl_setopt($ch, CURLOPT_POST, true);
25
26    // 送信するPOSTデータを設定します。
27    // 連想配列でデータを渡すと、cURLが自動的に "name=Beginner+SE&message=..." のようにURLエンコードします。
28    $postData = [
29        'name' => 'Beginner SE',
30        'message' => 'Hello from PHP cURL!',
31        'language' => 'PHP',
32    ];
33    curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
34
35    // 接続先のポート番号を明示的に設定する例です。
36    // HTTPSの標準ポートは443です。
37    // このオプションは、URLにポート番号が明示されていない場合に、指定したポートに接続する際に使用されます。
38    // 通常は標準ポート（HTTP:80, HTTPS:443）が自動的に使用されますが、
39    // 非標準ポートに接続する場合や、明示的に指定したい場合に使います。
40    // 今回のURL (https://...) ではポート443がデフォルトで使用されるため、
41    // 明示的に443を設定しても挙動に変化はありませんが、設定方法を示しています。
42    curl_setopt($ch, CURLOPT_PORT, 443);
43
44    // サーバーからのレスポンスを文字列として取得するように設定します。
45    // これを true にしない場合、レスポンスは直接出力されます。
46    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
47
48    // cURLリクエストを実行し、サーバーからのレスポンスを取得します。
49    $response = curl_exec($ch);
50
51    // cURL実行中にエラーが発生したか確認します。
52    if (curl_errno($ch)) {
53        $error_msg = curl_error($ch);
54        curl_close($ch); // エラーが発生した場合でも、cURLセッションは閉じるべきです。
55        return "cURLエラーが発生しました: " . $error_msg;
56    }
57
58    // cURLセッションを閉じ、リソースを解放します。
59    curl_close($ch);
60
61    return $response;
62}
63
64// 関数を実行し、結果（サーバーからのレスポンス）を表示します。
65echo performCurlPostRequestWithPort();
66
67?>

このPHPサンプルコードは、cURLライブラリを使用してHTTP POSTリクエストを送信し、特に接続先のポート番号を明示的に指定する方法をシステムエンジニアを目指す初心者向けに示しています。まず、curl_init()でcURLセッションを初期化し、CURLOPT_URLオプションでリクエスト先のURLを設定します。

POSTリクエストを行うには、CURLOPT_POSTをtrueに設定します。これにより、HTTPメソッドがPOSTとなり、CURLOPT_POSTFIELDSオプションで指定したデータがリクエストボディとして送信されます。ここでは、連想配列形式で渡されたデータがcURLによって自動的にURLエンコードされます。

CURLOPT_PORTは、接続先のポート番号を明示的に設定するための定数です。通常、HTTP通信では80番、HTTPS通信では443番ポートが自動的に使用されますが、非標準のポートに接続したい場合や、セキュリティの観点から明示的に指定したい場合にこのオプションを利用します。サンプルではHTTPSの標準ポートである443番を設定していますが、これはあくまで設定方法を示す例です。

最後に、CURLOPT_RETURNTRANSFERをtrueにすることで、サーバーからのレスポンスを文字列として取得するように設定し、curl_exec()でリクエストを実行します。エラーが発生した場合はcurl_errno()で確認し、最終的にcurl_close()でcURLセッションを閉じます。この関数は引数を取りませんが、成功時にはサーバーからのレスポンス文字列を、エラー時にはエラーメッセージを戻り値として返します。