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

Copy
1<?php
2
3/**
4 * 指定されたURLへのcURLリクエストを実行し、ダウンロードサイズとHTTPレスポンスコードを取得します。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、cURLの基本的な使用方法と
7 * `CURLINFO_SIZE_DOWNLOAD_T` および `CURLINFO_RESPONSE_CODE` 定数の利用例を示します。
8 *
9 * @param string $url リクエストを送信するターゲットURL。
10 * @return void
11 */
12function getCurlDownloadInfo(string $url): void
13{
14    // 1. cURLセッションを初期化します。
15    // curl_init() は新しい cURL セッションを初期化し、ハンドルを返します。
16    $ch = curl_init();
17
18    // 初期化に失敗した場合はエラーメッセージを表示して終了します。
19    if ($ch === false) {
20        echo "エラー: cURLセッションの初期化に失敗しました。\n";
21        return;
22    }
23
24    // 2. cURLオプションを設定します。
25    // CURLOPT_URL: リクエストを送信するURLを指定します。
26    curl_setopt($ch, CURLOPT_URL, $url);
27    // CURLOPT_RETURNTRANSFER: curl_exec() が結果を文字列で返すように設定します。
28    // これを true にしないと、結果は直接出力されてしまいます。
29    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
30    // CURLOPT_TIMEOUT: cURLリクエストの実行タイムアウトを秒単位で設定します。
31    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
32    // CURLOPT_FOLLOWLOCATION: HTTPヘッダーの "Location:" にしたがってリダイレクトを追跡します。
33    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
34
35    // 3. cURLリクエストを実行します。
36    // 実行結果は $response に格納されます。エラーの場合は false を返します。
37    $response = curl_exec($ch);
38
39    // 4. cURLリクエストの実行結果をチェックします。
40    if ($response === false) {
41        // エラーが発生した場合は、curl_error() で詳細なエラーメッセージを取得します。
42        echo "エラー: cURLリクエストの実行中に問題が発生しました。\n";
43        echo "詳細: " . curl_error($ch) . "\n";
44        // エラーが発生しても、curl_getinfo() は利用できる場合があるため、処理を続行することも可能です。
45        // ただし、今回はシンプルにするため、ここで終了します。
46        curl_close($ch);
47        return;
48    }
49
50    // 5. curl_getinfo() を使ってcURLセッションの情報を取得します。
51
52    // CURLINFO_SIZE_DOWNLOAD_T: ダウンロードされたバイト数を64ビット整数で取得します。
53    // 大容量ファイルのダウンロードサイズに対応するため、CURLINFO_SIZE_DOWNLOAD の64ビット版です。
54    $downloadSize = curl_getinfo($ch, CURLINFO_SIZE_DOWNLOAD_T);
55
56    // CURLINFO_RESPONSE_CODE: 最後に受信したHTTPレスポンスコードを取得します（例: 200, 404, 500）。
57    $httpResponseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
58
59    // 6. 取得した情報を表示します。
60    echo "--- cURL リクエスト情報 ---\n";
61    echo "ターゲットURL: {$url}\n";
62    // 取得した値が false でないか確認し、わかりやすく表示します。
63    echo "ダウンロードされたコンテンツサイズ (バイト): " . ($downloadSize !== false ? $downloadSize : "取得失敗") . "\n";
64    echo "HTTP レスポンスコード: " . ($httpResponseCode !== false ? $httpResponseCode : "取得失敗") . "\n";
65    echo "--------------------------\n";
66
67    // 7. cURLセッションを閉じ、リソースを解放します。
68    curl_close($ch);
69}
70
71// --- サンプルコードの実行例 ---
72// 実際にアクセス可能なURLを指定してください。
73// ここでは一般的なウェブサイトを例として使用しています。
74$targetUrl = "https://www.example.com/";
75getCurlDownloadInfo($targetUrl);
76
77// 別のURLで試すこともできます。
78// $anotherUrl = "https://httpbin.org/get"; // HTTP GETリクエストの情報を提供するサイト
79// getCurlDownloadInfo($anotherUrl);
80
81?>

このサンプルコードは、PHPのcURLライブラリを用いてWebサイトから情報を取得し、そのダウンロードサイズとHTTPレスポンスコードを表示する基本的な方法を、システムエンジニアを目指す初心者向けに解説しています。

CURLINFO_SIZE_DOWNLOAD_Tは、cURLリクエストによってダウンロードされたコンテンツの合計サイズをバイト単位で取得するための定数です。この定数をcurl_getinfo()関数に渡すと、int型の数値としてダウンロードサイズが返されます。特に、この定数は64ビット整数に対応しており、非常に大きなサイズのファイルをダウンロードした場合でも正確な値を取得できる利点があります。

また、CURLINFO_RESPONSE_CODEは、最後に受信したHTTPレスポンスコード（例：200 OK、404 Not Foundなど）を取得するための定数です。同様にcurl_getinfo()関数と組み合わせて使用することで、int型のHTTPステータスコードが返され、リクエストの成否や状況を判断するのに役立ちます。

サンプルコードでは、まずcurl_init()でcURLセッションを初期化し、CURLOPT_URLなどのオプションでリクエスト先のURLや動作を設定します。その後、curl_exec()でリクエストを実行し、成功した場合にcurl_getinfo()を用いてCURLINFO_SIZE_DOWNLOAD_TとCURLINFO_RESPONSE_CODEで必要な情報を取得し、画面に表示しています。最後にcurl_close()でリソースを解放するまでの一連の流れを示しており、Webアクセスの基礎を学ぶ上で参考になります。

Copy
1<?php
2
3/**
4 * CURLINFO_SIZE_DOWNLOAD_T 定数を使用して、指定されたURLのダウンロードサイズを取得します。
5 *
6 * この関数は、システムエンジニアを目指す初心者がcURL拡張機能と定数の使い方を理解できるように設計されています。
7 * 実際にはデータがダウンロードされますが、そのコンテンツはメモリ上で破棄されます。
8 *
9 * @param string $url ダウンロードサイズを取得する対象のURL。
10 * @return int|false ダウンロードされたバイト数、またはエラーの場合はfalse。
11 */
12function getDownloadSizeFromUrl(string $url): int|false
13{
14    // cURL拡張機能がロードされているか確認します。
15    // CURLINFO_SIZE_DOWNLOAD_T 定数はこの拡張機能の一部です。
16    if (!extension_loaded('curl')) {
17        echo "エラー: cURL 拡張機能がロードされていません。\n";
18        return false;
19    }
20
21    // cURL セッションを初期化します。
22    $ch = curl_init();
23
24    // URL を設定します。
25    curl_setopt($ch, CURLOPT_URL, $url);
26
27    // curl_exec() が取得したデータを文字列として返すように設定します。
28    // これにより、実際にデータが転送され、CURLINFO_SIZE_DOWNLOAD_T が正しく取得できます。
29    // ただし、この関数では取得したデータ自体は使用せず、破棄されます。
30    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
31
32    // ヘッダーは不要なので取得しないようにします。
33    curl_setopt($ch, CURLOPT_HEADER, false);
34    
35    // タイムアウトを設定します（秒）。
36    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
37
38    // 実際にリクエストを実行します。
39    // 戻り値は破棄されますが、データの転送自体は行われます。
40    curl_exec($ch);
41
42    // cURL エラーを確認します。
43    if (curl_errno($ch)) {
44        echo "cURL エラー: " . curl_error($ch) . "\n";
45        curl_close($ch);
46        return false;
47    }
48
49    // CURLINFO_SIZE_DOWNLOAD_T 定数を使用して、ダウンロードされた合計バイト数を取得します。
50    // この値は、転送されたボディのサイズを示します。
51    $downloadSize = curl_getinfo($ch, CURLINFO_SIZE_DOWNLOAD_T);
52
53    // cURL セッションを閉じます。
54    curl_close($ch);
55
56    return $downloadSize;
57}
58
59// サンプルとして、信頼できるWebサイトのURLを指定します。
60// 小さなファイルを指定すると、より安定した結果が得られる場合があります。
61$sampleUrl = "https://example.com/";
62
63echo "URL: " . $sampleUrl . " からのダウンロードサイズを取得します。\n";
64$size = getDownloadSizeFromUrl($sampleUrl);
65
66if ($size !== false) {
67    echo "ダウンロードサイズ: " . $size . " バイト\n";
68} else {
69    echo "ダウンロードサイズの取得に失敗しました。\n";
70}
71
72?>

このPHPサンプルコードは、cURL拡張機能を利用して、指定されたURLからダウンロードされるコンテンツのサイズを正確に取得する方法を示しています。中心となるCURLINFO_SIZE_DOWNLOAD_T定数は、HTTPリクエストによって転送されたデータの本体（ボディ）の合計バイト数を示すために使用されます。

getDownloadSizeFromUrl関数は、ダウンロードサイズを知りたいURLを文字列で引数として受け取ります。関数内では、まずextension_loaded('curl')でcURL拡張機能がシステムにロードされているかを確認します。この情報は、phpinfo()で確認できる要素の一つです。

次に、curl_init()でcURLセッションを初期化し、curl_setopt()を用いてターゲットURLや、データを受信するための設定（CURLOPT_RETURNTRANSFERをtrueに設定）を行います。これにより、実際にデータ転送が実行され、サイズが計測可能となります。curl_exec()を実行すると、指定されたURLへのHTTPリクエストが送信され、データがダウンロードされます。この際、ダウンロードされたデータ自体はメモリ上で破棄されますが、サイズ計測のためにはこの転送が必要です。

最後に、curl_getinfo()関数にCURLINFO_SIZE_DOWNLOAD_T定数を指定することで、ダウンロードされたコンテンツの正確なバイト数が取得されます。処理が成功した場合はダウンロードサイズ（整数）を、エラーが発生した場合はfalseを戻り値として返します。このコードは、cURLの基本的な使用方法と、特定の転送情報を取得するための定数の活用をシステムエンジニアを目指す初心者の方にも理解しやすいように設計されています。