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

Copy
1<?php
2
3/**
4 * CURLINFO_CONTENT_LENGTH_UPLOAD_T 定数を使用して、
5 * cURLアップロード操作におけるコンテンツ長を取得するサンプル関数。
6 *
7 * この定数は、curl_getinfo() 関数で利用され、
8 * クライアントによって認識されたアップロードデータのコンテンツ長を返します。
9 * 主にPUTやPOSTなどでファイルをアップロードする際に、
10 * その転送データのサイズを事後的に確認するのに役立ちます。
11 *
12 * 注意: このサンプルはダミーのURLに対してアップロードを試みるため、
13 * 実際には接続エラーが発生する可能性がありますが、
14 * クライアントが認識したアップロードサイズは取得できます。
15 *
16 * @return void
17 */
18function demonstrateCurlUploadContentLength(): void
19{
20    // 1. アップロードするダミーデータを作成するためのテンポラリファイルを用意
21    $tempFilePath = tempnam(sys_get_temp_dir(), 'curl_upload_test_');
22    if ($tempFilePath === false) {
23        echo "エラー: 一時ファイルの作成に失敗しました。\n";
24        return;
25    }
26
27    $uploadContent = "Hello, this is a test string to simulate an uploaded file.";
28    $bytesWritten = file_put_contents($tempFilePath, $uploadContent);
29
30    if ($bytesWritten === false) {
31        echo "エラー: 一時ファイルへの書き込みに失敗しました。\n";
32        @unlink($tempFilePath); // 失敗した場合でもファイル削除を試みる
33        return;
34    }
35
36    echo "一時ファイル '" . basename($tempFilePath) . "' を作成しました。\n";
37    echo "アップロードするコンテンツのサイズ (設定値): " . $bytesWritten . " バイト\n";
38
39    // 2. テンポラリファイルを読み込みモードでオープン
40    $fileHandle = fopen($tempFilePath, 'r');
41    if ($fileHandle === false) {
42        echo "エラー: 一時ファイルのオープンに失敗しました。\n";
43        @unlink($tempFilePath);
44        return;
45    }
46
47    // 3. cURLセッションを初期化
48    $ch = curl_init();
49    if ($ch === false) {
50        echo "エラー: cURLセッションの初期化に失敗しました。\n";
51        fclose($fileHandle);
52        @unlink($tempFilePath);
53        return;
54    }
55
56    // 4. cURLオプションを設定
57    // 実際には存在しないURLを設定しますが、クライアント側の情報は取得できます。
58    curl_setopt($ch, CURLOPT_URL, 'http://example.com/upload_target');
59    curl_setopt($ch, CURLOPT_UPLOAD, true);          // アップロードモードを有効にする
60    curl_setopt($ch, CURLOPT_READDATA, $fileHandle); // アップロードするファイルハンドルを指定
61    curl_setopt($ch, CURLOPT_INFILESIZE, $bytesWritten); // アップロードするファイルのサイズを指定
62    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);  // 実行結果を文字列で返す
63    curl_setopt($ch, CURLOPT_HEADER, false);         // レスポンスヘッダを含めない
64
65    echo "cURLリクエストを実行中... (ダミーURLへのアップロードを試みます)\n";
66
67    // 5. cURLリクエストを実行
68    // 存在しないURLのため、通常は接続エラーが発生します。
69    $response = curl_exec($ch);
70
71    // 6. CURLINFO_CONTENT_LENGTH_UPLOAD_T を使用してアップロードコンテンツ長を取得
72    $uploadContentLength = curl_getinfo($ch, CURLINFO_CONTENT_LENGTH_UPLOAD_T);
73    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
74    $curlError = curl_error($ch);
75    $curlErrno = curl_errno($ch);
76
77    echo "\n--- cURL 実行結果 ---\n";
78    echo "HTTPステータスコード: " . $httpCode . "\n";
79    if ($curlErrno !== 0) {
80        echo "cURLエラー (" . $curlErrno . "): " . $curlError . "\n";
81        echo "※ダミーURLへの接続エラーのため、このメッセージが表示されることがあります。\n";
82    }
83
84    // 取得したコンテンツ長を表示
85    if ($uploadContentLength !== null && $uploadContentLength >= 0) {
86        echo "CURLINFO_CONTENT_LENGTH_UPLOAD_T で取得したアップロードコンテンツ長: " . $uploadContentLength . " バイト\n";
87    } else {
88        echo "CURLINFO_CONTENT_LENGTH_UPLOAD_T の値を取得できませんでした。\n";
89    }
90
91    echo "\n--- クリーンアップ ---\n";
92
93    // 7. cURLセッションを閉じる
94    curl_close($ch);
95    echo "cURLセッションを閉じました。\n";
96
97    // 8. ファイルハンドルを閉じる
98    fclose($fileHandle);
99    echo "ファイルハンドルを閉じました。\n";
100
101    // 9. 一時ファイルを削除
102    if (unlink($tempFilePath)) {
103        echo "一時ファイル '" . basename($tempFilePath) . "' を削除しました。\n";
104    } else {
105        echo "一時ファイル '" . basename($tempFilePath) . "' の削除に失敗しました。\n";
106    }
107}
108
109// 関数を実行してデモンストレーション
110demonstrateCurlUploadContentLength();

PHPのCURLINFO_CONTENT_LENGTH_UPLOAD_T定数は、cURLを利用してファイルをアップロードする操作において、クライアント側が認識しているアップロードデータのコンテンツ長（バイト数）を取得するために使用されるものです。この定数はcurl_getinfo()関数に渡すことで、アップロード対象のデータサイズを取得できます。例えば、WebサーバーへファイルをPOSTまたはPUTで送信する際に、そのデータが何バイトだったのかを後から確認するのに役立ちます。

このサンプルコードでは、まずアップロードするデータを含む一時的なファイルを作成しています。次に、cURLセッションを初期化し、CURLOPT_UPLOADオプションをtrueに設定してアップロードモードを有効にしています。さらに、作成した一時ファイルと、そのファイルのサイズをCURLOPT_READDATAおよびCURLOPT_INFILESIZEで指定しています。

curl_exec()関数でアップロード処理を実行しますが、この例ではダミーのURLを使用しているため、実際には接続エラーが発生します。しかし、処理実行後、curl_getinfo()関数にCURLINFO_CONTENT_LENGTH_UPLOAD_T定数を渡すことで、cURLがアップロードしようと認識したデータの正確なサイズを取得できます。この値は、実際のアップロードの成否に関わらず、クライアントが転送しようとしたデータのサイズを示すため、デバッグや情報確認に活用できます。最後に、使用したcURLセッションや一時ファイルを適切にクリーンアップしています。

Copy
1<?php
2
3/**
4 * 指定されたURLへのHTTPリクエストを実行し、そのHTTPレスポンスコードを取得します。
5 * この関数は、システムエンジニアを目指す初心者向けに、PHPのcURL拡張機能の
6 * 基本的な使用方法と、`CURLINFO_RESPONSE_CODE`定数の利用例を示します。
7 *
8 * @param string $url リクエストを送信するターゲットURL。
9 * @return int|null HTTPレスポンスコード（例: 200, 404など）。リクエストが失敗した場合はnull。
10 */
11function getHttpResponseCode(string $url): ?int
12{
13    // cURLセッションを初期化します。
14    // cURLは、HTTP, HTTPS, FTPなど様々なプロトコルでデータを転送するためのライブラリです。
15    $ch = curl_init();
16
17    // cURLオプションを設定します。
18    // CURLOPT_URL: リクエストの送信先URLを指定します。
19    curl_setopt($ch, CURLOPT_URL, $url);
20
21    // CURLOPT_RETURNTRANSFER: curl_exec() が結果を文字列として返すようにします。
22    // これを設定しない場合、curl_exec() は直接出力し、戻り値は成功時にtrue、失敗時にfalseとなります。
23    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
24
25    // CURLOPT_TIMEOUT: ネットワーク操作のタイムアウト時間を秒単位で設定します。
26    curl_setopt($ch, CURLOPT_TIMEOUT, 5);
27
28    // cURLセッションを実行し、レスポンスを取得します。
29    $response = curl_exec($ch);
30
31    // cURLの実行中にエラーが発生したかどうかを確認します。
32    if (curl_errno($ch)) {
33        // エラーが発生した場合、エラーメッセージを出力し、nullを返します。
34        echo 'cURLエラー: ' . curl_error($ch) . PHP_EOL;
35        curl_close($ch); // セッションを閉じます
36        return null;
37    }
38
39    // curl_getinfo()関数を使って、cURLセッションに関する様々な情報を取得します。
40    // CURLINFO_RESPONSE_CODE は、直前のHTTPリクエストのHTTPレスポンスコード
41    // （HTTPステータスコード）を取得するための定数です。
42    // 例: 200 (OK), 404 (Not Found), 500 (Internal Server Error) など。
43    $httpStatusCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
44
45    // cURLセッションを閉じ、関連するリソースを解放します。
46    curl_close($ch);
47
48    // 取得したHTTPレスポンスコードを返します。
49    return $httpStatusCode;
50}
51
52// --- サンプル使用例 ---
53
54// 存在するURLに対してリクエストを実行します。
55$targetUrl = 'https://www.example.com';
56echo "URL: " . $targetUrl . PHP_EOL;
57$statusCode = getHttpResponseCode($targetUrl);
58
59if ($statusCode !== null) {
60    echo "HTTPレスポンスコード: " . $statusCode . PHP_EOL;
61    if ($statusCode >= 200 && $statusCode < 300) {
62        echo "ステータス: 成功 (2xx)." . PHP_EOL;
63    } elseif ($statusCode >= 400 && $statusCode < 500) {
64        echo "ステータス: クライアントエラー (4xx)." . PHP_EOL;
65    } elseif ($statusCode >= 500 && $statusCode < 600) {
66        echo "ステータス: サーバーエラー (5xx)." . PHP_EOL;
67    } else {
68        echo "ステータス: その他のコード." . PHP_EOL;
69    }
70} else {
71    echo "HTTPレスポンスコードの取得に失敗しました。" . PHP_EOL;
72}
73
74echo PHP_EOL;
75
76// 存在しない、または応答しない可能性のあるURLに対してリクエストを実行し、エラーを確認します。
77$invalidUrl = 'https://nonexistent-domain-for-test-12345.com';
78echo "URL: " . $invalidUrl . PHP_EOL;
79$statusCodeInvalid = getHttpResponseCode($invalidUrl);
80
81if ($statusCodeInvalid !== null) {
82    echo "HTTPレスポンスコード: " . $statusCodeInvalid . PHP_EOL;
83} else {
84    echo "HTTPレスポンスコードの取得に失敗しました。" . PHP_EOL;
85}
86
87?>

このサンプルコードは、PHPのcURL拡張機能を利用して、指定されたURLへのHTTPリクエストを実行し、そのHTTPレスポンスコードを取得する方法を示しています。

まず、curl_init()でcURLセッションを初期化し、curl_setopt()関数を用いて様々なオプションを設定します。ここでは、リクエスト先のURL（CURLOPT_URL）や、実行結果を文字列として返す設定（CURLOPT_RETURNTRANSFER）、タイムアウト時間（CURLOPT_TIMEOUT）などが設定されています。

設定後、curl_exec()で実際にHTTPリクエストを送信し、その応答を受け取ります。もしリクエスト中にエラーが発生した場合は、curl_errno()でエラーを確認し、詳細なエラーメッセージを出力します。

特に重要なのは、curl_getinfo()関数とその引数であるCURLINFO_RESPONSE_CODE定数です。CURLINFO_RESPONSE_CODEは、直前のHTTPリクエストで受け取ったHTTPステータスコード（例: 200, 404, 500など）を取得するための定数です。この値によって、リクエストが正常に処理されたか、クライアント側の問題か、サーバー側の問題かなどを判断できます。

最終的にcurl_close()でcURLセッションを閉じ、取得したHTTPレスポンスコードをgetHttpResponseCode関数の戻り値として返します。この関数は引数としてターゲットURLを受け取り、正常に取得できればHTTPレスポンスコード（整数）を、失敗した場合はnullを返します。このコードは、外部サービスの稼働状況確認やAPI連携時のエラーハンドリングなどに役立ちます。