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

Copy
1<?php
2
3/**
4 * cURLのCURLOPT_WRITEFUNCTIONを使用して、HTTPレスポンスボディをカスタム処理するサンプルです。
5 *
6 * この関数は、指定されたURLからコンテンツを取得し、
7 * 受信したデータをコールバック関数で処理する方法を示します。
8 * システムエンジニアを目指す初心者にも分かりやすいように、
9 * 受信データをそのまま画面に出力するシンプルな例です。
10 *
11 * @param string $url 取得するURL
12 * @return void
13 */
14function fetchContentWithCustomWriter(string $url): void
15{
16    // cURLセッションを初期化します。
17    $ch = curl_init();
18
19    if ($ch === false) {
20        echo "エラー: cURLの初期化に失敗しました。\n";
21        return;
22    }
23
24    // cURLオプションを設定します。
25    curl_setopt($ch, CURLOPT_URL, $url);
26
27    // CURLOPT_WRITEFUNCTION オプションを設定します。
28    // これは、cURLがサーバーからデータを受信するたびに呼び出されるコールバック関数です。
29    // コールバック関数は、cURLリソースと受信データ文字列を引数として受け取ります。
30    // そして、処理したデータのバイト数を正確に返す必要があります。
31    curl_setopt($ch, CURLOPT_WRITEFUNCTION, function ($curl, $data) {
32        // ここで受信したデータ $data を処理します。
33        // 例として、受信したデータチャンクを画面に出力します。
34        echo "--- 受信データチャンク (" . strlen($data) . "バイト) ---\n";
35        echo $data; // レスポンスボディの内容
36        
37        // 処理したデータのバイト数を返します。
38        // これが受信したデータ $data のバイト数と異なる場合、cURLはエラーと見なします。
39        return strlen($data);
40    });
41
42    // CURLOPT_RETURNTRANSFER は設定しない（または false にする）ことが推奨されます。
43    // これにより、curl_exec() は受信データを文字列として返さず、
44    // すべてのデータ処理を CURLOPT_WRITEFUNCTION に任せることになります。
45
46    // cURLセッションを実行します。
47    curl_exec($ch);
48
49    // エラーが発生した場合は表示します。
50    if (curl_errno($ch)) {
51        echo "\ncURLエラー (" . curl_errno($ch) . "): " . curl_error($ch) . "\n";
52    } else {
53        echo "\ncURLセッションが正常に完了しました。\n";
54    }
55
56    // cURLセッションを閉じ、リソースを解放します。
57    curl_close($ch);
58}
59
60// サンプルとして、HTTPリクエストを送信するURLを指定して関数を実行します。
61// 実際には、アクセス可能な任意のWebサイトのURLを指定できます。
62fetchContentWithCustomWriter("http://example.com");
63

このPHPコードは、cURLのCURLOPT_WRITEFUNCTIONオプションを利用して、HTTPレスポンスボディの受信データをカスタム処理する方法を初心者向けに示しています。

まず、curl_init()でcURLセッションを初期化し、CURLOPT_URLオプションでリクエストを送信するURLを設定します。このコードの主要な部分はCURLOPT_WRITEFUNCTIONオプションです。このオプションには、cURLがサーバーからデータを受信するたびに呼び出されるコールバック関数を指定します。

指定するコールバック関数は、第一引数にcURLリソース、第二引数にサーバーから受信したデータの文字列を受け取ります。このサンプルでは、受信したデータのチャンク（一部）をそのまま画面に出力することで、データがどのように分割されて届くかを示しています。コールバック関数の戻り値は非常に重要で、処理したデータの正確なバイト数を整数で返す必要があります。もし返されたバイト数が実際に受信したデータのバイト数と一致しない場合、cURLはエラーと判断し、処理を中断します。

通常、CURLOPT_RETURNTRANSFERオプションは設定しないかfalseにすることで、curl_exec()関数が受信データを文字列として直接返さず、すべてのデータ処理をCURLOPT_WRITEFUNCTIONに設定したコールバック関数に委ねる形となります。これにより、メモリ効率の良いデータ処理が可能になります。最後に、curl_exec()でリクエストを実行し、curl_close()でセッションを閉じ、リソースを解放します。

Copy
1<?php
2
3/**
4 * 指定されたURLにPOSTリクエストを送信し、そのレスポンスを返します。
5 *
6 * @param string $url POSTリクエストを送信するURL。
7 * @param array $postData 連想配列形式のPOSTデータ。
8 * @return string|false 成功した場合はレスポンス文字列、失敗した場合はfalse。
9 */
10function sendPostRequest(string $url, array $postData)
11{
12    // cURLセッションを初期化します。
13    $ch = curl_init();
14
15    // cURLオプションを設定します。
16    curl_setopt($ch, CURLOPT_URL, $url); // リクエストを送信するURLを設定します。
17    curl_setopt($ch, CURLOPT_POST, true); // POSTリクエストを有効にします。
18
19    // キーワード: CURLOPT_POSTFIELDS
20    // 送信するPOSTデータを設定します。
21    // 配列形式で渡すと、cURLは自動的に 'application/x-www-form-urlencoded' 形式にエンコードします。
22    curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
23
24    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // 実行結果を文字列として取得するように設定します。
25
26    // リクエストを実行し、レスポンスを取得します。
27    $response = curl_exec($ch);
28
29    // cURLエラーが発生したかを確認します。
30    if (curl_errno($ch)) {
31        echo 'cURLエラー: ' . curl_error($ch) . PHP_EOL;
32        $response = false;
33    }
34
35    // cURLセッションを閉じます。
36    curl_close($ch);
37
38    return $response;
39}
40
41// --- サンプル使用例 ---
42// 実際の利用では、POSTリクエストを受け付ける有効なエンドポイントを使用してください。
43// この例では、ダミーのAPIエンドポイントを提供するサービス (JSONPlaceholder) を使用します。
44$targetUrl = 'https://jsonplaceholder.typicode.com/posts';
45
46// 送信するデータ
47$dataToSend = [
48    'title' => 'foo',
49    'body' => 'bar',
50    'userId' => 1,
51];
52
53echo "URL: " . $targetUrl . PHP_EOL;
54echo "送信データ: " . json_encode($dataToSend, JSON_UNESCAPED_UNICODE) . PHP_EOL;
55echo "----------------------------------------" . PHP_EOL;
56
57// POSTリクエストを送信し、結果を受け取ります。
58$result = sendPostRequest($targetUrl, $dataToSend);
59
60if ($result !== false) {
61    echo "POSTリクエスト成功！ レスポンス:" . PHP_EOL;
62    echo $result . PHP_EOL;
63} else {
64    echo "POSTリクエスト失敗。" . PHP_EOL;
65}

このPHPサンプルコードは、cURLライブラリを利用してHTTP POSTリクエストを送信する基本的な方法を示しています。sendPostRequest関数は、送信先のURLを文字列として、送信するPOSTデータを連想配列として引数に受け取ります。

関数内部では、まずcurl_init()でcURLセッションを初期化します。次にcurl_setopt()関数を用いて各種オプションを設定します。CURLOPT_URLにはリクエストを送信するターゲットのURLを設定し、CURLOPT_POSTをtrueにすることで、HTTPメソッドがPOSTであることをcURLに明示します。

特に重要なオプションとして、CURLOPT_POSTFIELDSがあります。ここに連想配列形式のデータを渡すと、cURLは自動的にデータをURLエンコードし、POSTリクエストのボディとしてサーバーに送信します。CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果が直接出力されるのではなく、関数の戻り値として文字列で取得できるようになります。

リクエストの実行後、curl_errno()でエラーが発生していないかを確認し、エラーがあればその詳細を表示します。最終的にcurl_close()でcURLセッションを終了します。この関数は、POSTリクエストが成功した場合にはサーバーからのレスポンス文字列を返し、失敗した場合にはfalseを返します。サンプル使用例では、ダミーAPIに対してデータを送信し、その結果を受け取るまでの一連の流れが確認できます。