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

Copy
1<?php
2
3/**
4 * 指定されたURLからHTTPレスポンスコードを取得します。
5 * システムエンジニアを目指す初心者の方へ：
6 * この関数は、ウェブサイトが正しく動作しているか（例: ページが見つかるか、サーバーエラーがないか）
7 * を確認する際によく使われるHTTPステータスコードを取得する方法を示しています。
8 *
9 * @param string $url 取得対象のURL（例: 'https://example.com'）
10 * @return int|false HTTPレスポンスコード（例: 200, 404, 500）、またはエラー時はfalse
11 */
12function getHttpResponseCode(string $url): int|false
13{
14    // cURLセッションを初期化します。
15    // cURLは、様々なプロトコルを使ってデータ転送を行うためのライブラリです。
16    // ここでは、指定したURLにHTTPリクエストを送信するために使います。
17    $ch = curl_init();
18
19    // cURL初期化が失敗した場合は、エラーを記録して処理を中断します。
20    if ($ch === false) {
21        error_log("cURLセッションの初期化に失敗しました。PHPのcURL拡張機能が有効になっているか確認してください。");
22        return false;
23    }
24
25    // cURLオプションを設定します。
26    //
27    // CURLOPT_URL: リクエストを送信するURLを設定します。
28    curl_setopt($ch, CURLOPT_URL, $url);
29    //
30    // CURLOPT_RETURNTRANSFER: curl_exec() 関数が実行結果を直接出力せず、
31    // 文字列として返すように設定します。これにより、結果を変数に格納できます。
32    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
33    //
34    // CURLOPT_HEADER: HTTPヘッダーをボディと一緒に出力しないように設定します。
35    // レスポンスコードのみが必要な場合は通常 false にします。
36    curl_setopt($ch, CURLOPT_HEADER, false);
37    //
38    // CURLOPT_FOLLOWLOCATION: HTTPリダイレクト（例: 301 Moved Permanently）があった場合に、
39    // 自動的にリダイレクト先のURLを追跡するように設定します。
40    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
41    //
42    // CURLOPT_SSL_VERIFYPEER と CURLOPT_SSL_VERIFYHOST:
43    // これらのオプションは、HTTPSサイトのSSL証明書の検証を制御します。
44    // 開発時には false にすることもありますが、本番環境ではセキュリティ上の理由から
45    // 通常は true に設定し、証明書を検証すべきです。
46    // 例として含めますが、実運用ではセキュリティを考慮してください。
47    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
48    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
49    //
50    // CURLOPT_TIMEOUT: cURL操作が完了するまでの最大時間を秒単位で設定します。
51    // これにより、応答のないサーバーからの無限の待機を防ぎます。
52    curl_setopt($ch, CURLOPT_TIMEOUT, 10); // タイムアウトを10秒に設定
53
54    // cURLセッションを実行し、URLからデータを取得します。
55    // CURLOPT_RETURNTRANSFER が true なので、取得されたコンテンツは $response に格納されます。
56    $response = curl_exec($ch);
57
58    // cURL操作中にエラーが発生したか確認します。
59    if (curl_errno($ch)) {
60        // エラーがあった場合は、エラーメッセージを記録し、セッションを閉じて処理を中断します。
61        error_log("cURLエラーが発生しました: " . curl_error($ch));
62        curl_close($ch);
63        return false;
64    }
65
66    // cURLセッションからHTTPレスポンスコードを取得します。
67    // CURLINFO_RESPONSE_CODE は、HTTPステータスコード（例: 200 OK, 404 Not Found, 500 Internal Server Error）
68    // を取得するための定数です。これは、ウェブサーバーがリクエストに対してどのような状態を返したかを示します。
69    $httpCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
70
71    // cURLセッションを閉じ、使用したリソースを解放します。
72    curl_close($ch);
73
74    return $httpCode;
75}
76
77// --- サンプル使用例 ---
78
79// テスト用のURLを設定します。
80$testUrlSuccess = "https://example.com";
81$testUrlNotFound = "https://example.com/non-existent-page-12345"; // 存在しない可能性が高いURL
82
83echo "--- HTTPレスポンスコード取得のサンプル ---" . PHP_EOL . PHP_EOL;
84
85// 存在するURLのレスポンスコードを取得する例
86echo "対象URL: " . $testUrlSuccess . PHP_EOL;
87$statusCodeSuccess = getHttpResponseCode($testUrlSuccess);
88
89if ($statusCodeSuccess !== false) {
90    echo "取得されたHTTPレスポンスコード: " . $statusCodeSuccess . PHP_EOL;
91    switch ($statusCodeSuccess) {
92        case 200:
93            echo "ステータス: 成功 (OK) - ページが正常に取得できました。" . PHP_EOL;
94            break;
95        case 301:
96        case 302:
97            echo "ステータス: リダイレクト - 別のURLへ転送されています。" . PHP_EOL;
98            break;
99        case 404:
100            echo "ステータス: 見つかりません (Not Found) - ページが見つかりませんでした。" . PHP_EOL;
101            break;
102        case 500:
103            echo "ステータス: サーバー内部エラー - サーバーで問題が発生しています。" . PHP_EOL;
104            break;
105        default:
106            echo "ステータス: その他 (" . $statusCodeSuccess . ") - 予期しないステータスです。" . PHP_EOL;
107            break;
108    }
109} else {
110    echo "エラー: " . $testUrlSuccess . " からHTTPレスポンスコードを取得できませんでした。" . PHP_EOL;
111}
112
113echo PHP_EOL . "----------------------------------" . PHP_EOL . PHP_EOL;
114
115// 存在しないURLのレスポンスコードを取得する例
116echo "対象URL: " . $testUrlNotFound . PHP_EOL;
117$statusCodeNotFound = getHttpResponseCode($testUrlNotFound);
118
119if ($statusCodeNotFound !== false) {
120    echo "取得されたHTTPレスポンスコード: " . $statusCodeNotFound . PHP_EOL;
121    if ($statusCodeNotFound === 404) {
122        echo "ステータス: 見つかりません (Not Found) - 期待通りページが見つかりませんでした。" . PHP_EOL;
123    } else {
124        echo "ステータス: その他 (" . $statusCodeNotFound . ") - 予期しないステータスです。" . PHP_EOL;
125    }
126} else {
127    echo "エラー: " . $testUrlNotFound . " からHTTPレスポンスコードを取得できませんでした。" . PHP_EOL;
128}
129
130echo PHP_EOL . "--- サンプル終了 ---" . PHP_EOL;
131

このPHPサンプルコードは、指定されたウェブサイトのHTTPレスポンスコードを取得するためのものです。これは、ウェブサイトが正常に稼働しているか、特定のリソースが見つかるかなどをプログラムから確認したい場合に役立ちます。

コードはPHPのcURL拡張機能を利用して、外部のウェブサーバーと通信します。まずcurl_init()でcURLセッションを開始し、curl_setopt()関数でアクセスするURLや、リダイレクトを追跡するかといった詳細なオプションを設定します。特に、CURLOPT_RETURNTRANSFERをtrueにすることで、ウェブサーバーからの応答内容を変数に格納できるようになります。その後、curl_exec()で実際にウェブサイトへリクエストを送信し、データを受信します。

リクエストが完了したら、curl_getinfo()関数にCURLINFO_RESPONSE_CODEという定数を指定することで、ウェブサーバーが返したHTTPステータスコード（例: 200 OK、404 Not Found、500 Internal Server Errorなど）を取得します。このコードは、リクエストの結果がどのような状態であったかを示します。最後にcurl_close()でcURLセッションを閉じ、使用したリソースを解放します。

この関数は引数として $url に確認したいウェブサイトのアドレス（文字列）を受け取ります。戻り値は、正常にレスポンスコードが取得できた場合は整数値、エラーが発生した場合は false となります。これにより、ウェブサイトの健全性を確認する基本的な仕組みを学習できます。

Copy
1<?php
2
3/**
4 * CURLINFO_SPEED_UPLOAD_T 定数を使用して、POSTリクエストのアップロード速度を取得するサンプル。
5 *
6 * この関数は、指定されたURLにデータをPOSTし、その際に観測された
7 * アップロード速度（バイト/秒）を取得して表示します。
8 * システムエンジニアを目指す初心者が、CURLINFO_SPEED_UPLOAD_T定数の
9 * 具体的な使用方法を理解するのに役立ちます。
10 *
11 * @param string $url POSTリクエストの送信先URL。
12 * @param array $postData POSTするデータ（キーと値のペア）。
13 * @return void
14 */
15function demonstrateCurlUploadSpeed(string $url, array $postData): void
16{
17    // 1. cURLセッションを初期化する
18    $ch = curl_init();
19
20    // 初期化に失敗した場合はエラーメッセージを表示して終了
21    if ($ch === false) {
22        echo "エラー: cURLセッションの初期化に失敗しました。\n";
23        return;
24    }
25
26    // POSTデータをHTTPクエリ文字列形式に変換 (例: "name=value&key=value")
27    $encodedPostData = http_build_query($postData);
28
29    // 2. cURLオプションを設定する
30    curl_setopt($ch, CURLOPT_URL, $url);                      // リクエストを送信するURL
31    curl_setopt($ch, CURLOPT_POST, true);                     // POSTメソッドを使用することを指定
32    curl_setopt($ch, CURLOPT_POSTFIELDS, $encodedPostData);   // POSTするデータ本体
33    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);           // レスポンスを文字列として受け取る
34
35    echo "ターゲットURL: " . $url . "\n";
36    echo "送信データサイズ: " . strlen($encodedPostData) . " バイト\n";
37    echo "POSTリクエストを実行中...\n";
38
39    // 3. cURLリクエストを実行する
40    // 実行結果は$responseに格納されるが、この例ではアップロード速度が主な目的
41    $response = curl_exec($ch);
42
43    // 4. cURL実行中のエラーをチェックする
44    if (curl_errno($ch)) {
45        echo 'cURLエラーが発生しました: ' . curl_error($ch) . "\n";
46    } else {
47        // 5. CURLINFO_SPEED_UPLOAD_T定数を使用してアップロード速度を取得する
48        // curl_getinfo()関数は、cURLセッションに関する様々な情報を取得するために使われます。
49        // CURLINFO_SPEED_UPLOAD_Tは、転送で観測されたアップロード速度の合計をバイト/秒で返します。
50        $uploadSpeed = curl_getinfo($ch, CURLINFO_SPEED_UPLOAD_T);
51
52        echo "リクエストが完了しました。\n";
53        echo "観測されたアップロード速度: " . number_format($uploadSpeed, 2) . " バイト/秒\n";
54
55        // 必要であれば、サーバーからのレスポンスも表示
56        // echo "\nサーバーレスポンス:\n" . $response . "\n";
57    }
58
59    // 6. cURLセッションを閉じる
60    // これにより、関連するリソースが解放されます。
61    curl_close($ch);
62}
63
64// -- サンプル使用例 --
65// テスト用の公開エンドポイントとして 'https://httpbin.org/post' を使用します。
66// これはPOSTリクエストを受け取り、送信されたデータをJSON形式で返すサービスです。
67$targetUrl = 'https://httpbin.org/post';
68
69// アップロードするダミーデータ。少し多めのデータを用意することで、速度測定の精度が向上する場合があります。
70$dataToUpload = [
71    'username' => 'sample_user',
72    'email' => 'user@example.com',
73    'message' => 'このメッセージは、cURLアップロード速度の測定テストのために送信されました。',
74    'large_payload' => str_repeat('X', 1024 * 50) // 50KBのダミーデータ
75];
76
77// 関数を実行してアップロード速度を表示
78demonstrateCurlUploadSpeed($targetUrl, $dataToUpload);
79
80?>

PHP 8のCURLINFO_SPEED_UPLOAD_T定数は、cURLセッションにおけるデータ転送のうち、アップロード処理の平均速度をバイト/秒単位で取得するために用いられます。この定数は、特定のcURLリクエストがデータをアップロードする際のパフォーマンスを測定する際に役立ちます。

提供されたサンプルコードでは、demonstrateCurlUploadSpeedという関数が、指定されたURLへデータをPOSTし、その際に観測されたアップロード速度を測定・表示します。この関数は、POSTリクエストの送信先URLと送信するデータ（キーと値のペア）を引数として受け取ります。内部では、まずcurl_init()でcURLセッションを初期化し、CURLOPT_URLで送信先URL、CURLOPT_POSTとCURLOPT_POSTFIELDSでPOSTデータを設定します。リクエストはcurl_exec()で実行され、転送が完了した後、curl_getinfo($ch, CURLINFO_SPEED_UPLOAD_T)を用いてアップロード速度が取得されます。curl_getinfo()関数は、cURLリソースと情報を示す定数を受け取り、その情報を戻り値として返します。最後に取得された速度が表示され、curl_close()でセッションが閉じられます。demonstrateCurlUploadSpeed関数自体の戻り値はありません。この一連の処理により、実際にデータがアップロードされた際の速度を数値として確認できます。