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

Copy
1<?php
2
3/**
4 * 指定されたURLからコンテンツを取得し、文字列として返します。
5 * CURLOPT_RETURNTRANSFER を使用して、cURLの実行結果を直接出力する代わりに
6 * 関数の戻り値として取得する方法を示します。
7 *
8 * @param string $url 取得するURL。
9 * @return string|false 成功した場合はURLのコンテンツ、失敗した場合はfalseを返します。
10 */
11function fetchUrlContent(string $url): string|false
12{
13    // cURLセッションを初期化します。
14    $ch = curl_init();
15
16    // cURLオプションを設定します。
17    // 取得するURLを設定します。
18    curl_setopt($ch, CURLOPT_URL, $url);
19
20    // CURLOPT_RETURNTRANSFER を true に設定することで、
21    // curl_exec() が結果を直接出力するのではなく、文字列として返すようになります。
22    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
23
24    // HTTPステータスコードが400以上の場合、cURLがエラーを発生させるようにします。
25    curl_setopt($ch, CURLOPT_FAILONERROR, true);
26
27    // cURLセッションを実行し、コンテンツを取得します。
28    $response = curl_exec($ch);
29
30    // エラーが発生したかチェックします。
31    if (curl_errno($ch)) {
32        // エラーメッセージを表示します。
33        echo 'cURL エラー: ' . curl_error($ch);
34        $response = false; // エラー時はfalseを返します。
35    }
36
37    // cURLセッションを閉じます。
38    curl_close($ch);
39
40    return $response;
41}
42
43// サンプルとして、指定されたURLのコンテンツを取得してみます。
44// このURLはPHP公式ドキュメントの例としてよく使われるダミーURLです。
45$targetUrl = 'http://example.com/';
46$content = fetchUrlContent($targetUrl);
47
48if ($content !== false) {
49    echo "URL: {$targetUrl} からコンテンツを取得しました。\n";
50    echo "取得したコンテンツの最初の200文字:\n";
51    echo mb_substr($content, 0, 200) . "...\n";
52} else {
53    echo "URL: {$targetUrl} からコンテンツの取得に失敗しました。\n";
54}
55
56?>

PHPにおけるCURLOPT_RETURNTRANSFERは、cURLエクステンションで使用される重要な定数の一つです。この定数をtrueに設定することで、curl_exec()関数の動作を制御し、ウェブサイトから取得したコンテンツをプログラム内で利用しやすくします。

通常、CURLOPT_RETURNTRANSFERが設定されていない場合、curl_exec()は取得したコンテンツをそのまま標準出力、つまりブラウザやコンソールに直接表示してしまいます。しかし、この定数をtrueに設定すると、curl_exec()はコンテンツを直接出力するのではなく、その内容を文字列として関数の戻り値として返します。これにより、取得したウェブページのHTMLやAPIのJSONデータなどを、変数に格納して後から加工したり、データベースに保存したり、ユーザーに特定の形式で表示したりといった柔軟な処理が可能になります。

サンプルコードでは、fetchUrlContent関数内でcurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);と設定することで、指定されたURLから取得したコンテンツが$response変数に文字列として格納され、関数からの戻り値として利用されています。これによって、コンテンツの取得が成功したかどうかのチェックや、取得した内容の一部を表示するといった処理を、PHPスクリプト内で安全かつ効率的に行うことができます。この定数は、外部リソースとの連携が求められる多くのシステム開発において、非常に頻繁に活用される基本的なオプションの一つです。

Copy
1<?php
2
3/**
4 * ダミーのチャンク転送をシミュレートする cURL リクエストを送信します。
5 *
6 * PHP 8 では CURLOPT_TRANSFER_ENCODING 定数は削除されています。
7 * この定数の意図（リクエストボディをチャンク形式で転送する）は、
8 * ストリーム転送設定（CURLOPT_UPLOAD や CURLOPT_READDATA）を適切に
9 * 使用することで、libcurl が自動的に Transfer-Encoding: chunked を適用します。
10 *
11 * @param string $url リクエストを送信するURL。例: 'https://httpbin.org/post'
12 * @return string|false サーバーからの応答、または失敗時には false
13 */
14function sendChunkedPostRequest(string $url): string|false
15{
16    $ch = curl_init();
17
18    // 送信するダミーデータを作成します。
19    // 実際には、ファイルハンドルなどから読み込むことが多いです。
20    $dummyData = "これは最初のチャンクです。\n"
21               . "これは2番目のチャンクで、少し長いです。\n"
22               . "これが最後のチャンクです。";
23
24    // 読み込み関数のために、データを含むメモリ上のストリームを準備します。
25    $dataStream = fopen('php://memory', 'r+');
26    fwrite($dataStream, $dummyData);
27    fseek($dataStream, 0); // ストリームの先頭に戻す
28
29    curl_setopt($ch, CURLOPT_URL, $url);
30    curl_setopt($ch, CURLOPT_POST, true); // POST リクエストを設定します。
31
32    // ストリームからのアップロードを有効にします。
33    curl_setopt($ch, CURLOPT_UPLOAD, true);
34
35    // 読み込み元となるファイルハンドル（またはストリーム）を指定します。
36    curl_setopt($ch, CURLOPT_READDATA, $dataStream);
37
38    // CURLOPT_INFILESIZE を設定しないことで、libcurl はデータの総サイズが不明であると判断し、
39    // 自動的に "Transfer-Encoding: chunked" ヘッダを使用してデータを送信します。
40    // PHP 8 で削除された CURLOPT_TRANSFER_ENCODING の機能は、
41    // このようにストリームアップロードと組み合わせることで実現されます。
42    // もしContent-Lengthヘッダを送信したい場合は、curl_setopt($ch, CURLOPT_INFILESIZE, strlen($dummyData)); を設定します。
43
44    // レスポンスヘッダも取得するように設定します（確認用）。
45    curl_setopt($ch, CURLOPT_HEADER, true);
46
47    // cURLが自動的に "Expect: 100-continue" ヘッダを送信するのを無効にします。
48    // これは、大容量データ送信時に初期のハンドシェイクを省略し、直接データ送信を開始するためです。
49    curl_setopt($ch, CURLOPT_HTTPHEADER, ['Expect:']);
50
51    // サーバーからの応答を文字列として受け取るように設定します。
52    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
53
54    $response = curl_exec($ch);
55
56    if (curl_errno($ch)) {
57        echo 'cURL エラー: ' . curl_error($ch) . "\n";
58        $response = false;
59    } else {
60        // レスポンスヘッダとボディを分離して表示します。
61        $headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
62        $responseHeaders = substr($response, 0, $headerSize);
63        $responseBody = substr($response, $headerSize);
64
65        echo "--- レスポンスヘッダ ---\n" . $responseHeaders . "\n";
66        echo "--- レスポンスボディ ---\n" . $responseBody . "\n";
67    }
68
69    curl_close($ch);
70    fclose($dataStream);
71
72    return $response;
73}
74
75// サンプル使用例
76// 実際にリクエストを送信するため、HTTP POST リクエストを受け付ける適切なURLに置き換えてください。
77// 例: https://httpbin.org/post は、受け取ったPOSTリクエストのヘッダとボディをJSON形式でエコーバックします。
78sendChunkedPostRequest('https://httpbin.org/post');

このサンプルコードは、PHP 8 で削除された CURLOPT_TRANSFER_ENCODING 定数の機能である「HTTPチャンク転送」を、現在のPHP環境でどのように実現するかを示しています。CURLOPT_TRANSFER_ENCODING は、HTTPリクエストボディを細かく分割して転送する際に使用される定数でしたが、PHP 8 以降では利用できません。

代替策として、このコードでは CURLOPT_UPLOAD オプションを true に設定し、CURLOPT_READDATA オプションに送信したいデータを含むストリーム（例：ファイルハンドル）を指定しています。この際、データの総サイズを CURLOPT_INFILESIZE で明示的に指定しないことで、libcurlライブラリが自動的に「Transfer-Encoding: chunked」ヘッダを付与し、チャンク形式でのデータ転送を行います。これにより、データのサイズが事前に不明な場合でも効率的にアップロードが可能です。

関数 sendChunkedPostRequest は、引数 $url で指定されたURLに対してPOSTリクエストを送信します。戻り値は、成功時にはサーバーからの応答内容を示す文字列、失敗時には false となります。この方法は、特に大きなファイルや動的に生成されるコンテンツをストリームとして転送する際に有効です。