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

Copy
1<?php
2
3/**
4 * 指定されたファイルの内容をHTTP PUTリクエストとしてアップロードします。
5 * CURLOPT_READDATAオプションの使用方法を示します。
6 *
7 * @param string $url アップロード先のURL。
8 * @param string $filePath アップロードするローカルファイルのパス。
9 * @return string|false cURLリクエストのレスポンス、または失敗した場合はfalse。
10 */
11function uploadFileWithCurlReadData(string $url, string $filePath): string|false
12{
13    // アップロード対象のファイルが存在し、読み取り可能かチェック
14    if (!file_exists($filePath) || !is_readable($filePath)) {
15        error_log("エラー: 指定されたファイル '{$filePath}' が見つからないか、読み取れません。");
16        return false;
17    }
18
19    // ファイルポインタを開く
20    // CURLOPT_READDATAはファイルポインタ（リソース）を期待します。
21    $fileHandle = fopen($filePath, 'r');
22    if (!$fileHandle) {
23        error_log("エラー: ファイル '{$filePath}' を開けませんでした。");
24        return false;
25    }
26
27    // アップロードするファイルのサイズを取得
28    $fileSize = filesize($filePath);
29    if ($fileSize === false) {
30        error_log("エラー: ファイル '{$filePath}' のサイズを取得できませんでした。");
31        fclose($fileHandle);
32        return false;
33    }
34
35    // cURLセッションを初期化
36    $ch = curl_init();
37    if ($ch === false) {
38        error_log("エラー: cURLセッションの初期化に失敗しました。");
39        fclose($fileHandle);
40        return false;
41    }
42
43    // cURLオプションを設定
44    curl_setopt($ch, CURLOPT_URL, $url);                 // リクエストURL
45    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);      // レスポンスを文字列として返す
46    curl_setopt($ch, CURLOPT_UPLOAD, true);              // ファイルアップロードを有効にする
47    curl_setopt($ch, CURLOPT_PUT, true);                 // HTTP PUTメソッドを使用する
48    curl_setopt($ch, CURLOPT_INFILESIZE, $fileSize);     // アップロードするファイルのサイズを指定
49
50    // ★ CURLOPT_READDATA: アップロードするデータの読み込み元となるファイルポインタを指定
51    // このオプションにファイルポインタを設定することで、cURLはそのファイルからデータを読み込み、
52    // リクエストボディとして送信します。
53    curl_setopt($ch, CURLOPT_READDATA, $fileHandle);
54
55    // cURLリクエストを実行
56    $response = curl_exec($ch);
57
58    // エラーチェック
59    if (curl_errno($ch)) {
60        $errorMsg = curl_error($ch);
61        error_log("cURLエラー (errno: " . curl_errno($ch) . "): " . $errorMsg);
62        $response = false;
63    }
64
65    // cURLセッションとファイルポインタを閉じる
66    curl_close($ch);
67    fclose($fileHandle);
68
69    return $response;
70}
71
72// --- サンプルコードの実行例 ---
73
74// 1. アップロード用のテストファイルを一時的に作成
75$tempFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_curl_upload_test.txt';
76$testContent = "これはCURLOPT_READDATAを使ってアップロードされるテストデータです。\n";
77$testContent .= "PHP cURL extension for beginners, version 8.\n";
78$testContent .= "時刻: " . date('Y-m-d H:i:s') . "\n";
79
80if (file_put_contents($tempFilePath, $testContent) === false) {
81    die("エラー: テストファイル '{$tempFilePath}' の作成に失敗しました。\n");
82}
83
84echo "テストファイル '{$tempFilePath}' を作成しました。\n";
85echo "内容:\n" . $testContent . "\n";
86
87// 2. アップロード先のURLを設定
88// httpbin.org はHTTPリクエストのテストに便利なサービスです。
89// /put エンドポイントはPUTリクエストを受け取り、その内容をJSONで返します。
90$targetUrl = 'https://httpbin.org/put';
91echo "URL: {$targetUrl} にファイルをアップロードしています...\n";
92
93// 3. 関数を呼び出してファイルをアップロード
94$uploadResponse = uploadFileWithCurlReadData($targetUrl, $tempFilePath);
95
96if ($uploadResponse !== false) {
97    echo "\n--- アップロードレスポンス (httpbin.org から) ---\n";
98    echo $uploadResponse;
99    echo "\n--------------------------------------------------\n";
100
101    // 応答のJSONをデコードして、アップロードされたデータを確認する例
102    $decodedResponse = json_decode($uploadResponse, true);
103    if ($decodedResponse && isset($decodedResponse['data'])) {
104        echo "\n--- httpbin.org が受信したデータ ('data' フィールド) ---\n";
105        echo $decodedResponse['data'];
106        echo "\n------------------------------------------------------\n";
107    }
108} else {
109    echo "\nファイルのアップロードに失敗しました。\n";
110}
111
112// 4. 使用した一時ファイルを削除
113if (file_exists($tempFilePath)) {
114    unlink($tempFilePath);
115    echo "一時ファイル '{$tempFilePath}' を削除しました。\n";
116}
117
118?>

このPHPコードは、CURLOPT_READDATAオプションを用いて、指定されたローカルファイルをHTTP PUTリクエストとしてウェブサーバーへアップロードする方法を示しています。CURLOPT_READDATAはcURLセッションにおいて、アップロードするデータの読み込み元となるファイルポインタ（fopenで開かれたファイルリソース）を指定するための定数です。このオプションを設定することで、cURLは指定されたファイルから直接データを効率的に読み込み、リクエストボディとして送信します。

関数uploadFileWithCurlReadDataは、アップロード先のURLとアップロードするローカルファイルのパスを引数として受け取ります。関数内部では、まずファイルを読み取りモードで開いてファイルポインタを取得し、このポインタをCURLOPT_READDATAオプションに設定します。他にも、CURLOPT_UPLOADをtrueに設定してアップロードを有効にし、CURLOPT_PUTをtrueにしてHTTP PUTメソッドを使用することを指定します。また、CURLOPT_INFILESIZEでアップロードするファイルの正確なサイズをcURLに伝えます。 cURLリクエストが成功した場合はサーバーからのレスポンス文字列を、処理中にエラーが発生した場合はfalseを戻り値として返します。ファイルが存在しない場合や読み取り不可能な場合、またはcURLセッションのエラーが発生した際には、適切なエラーログが出力されます。

Copy
1<?php
2
3/**
4 * 指定されたファイルをHTTP POSTリクエストでアップロードします。
5 *
6 * この関数はCURLOPT_READDATA (CURLOPT_INFILEのエイリアス) を使用して、
7 * ファイルの内容をリクエストボディとして送信します。
8 * これは、CURLOPT_POSTFIELDSでキーバリュー形式のデータを送る一般的なPOSTとは異なり、
9 * リクエストボディ全体をファイルストリームから読み込む場合に利用されます。
10 *
11 * @param string $url アップロード先のURL。
12 * @param string $filePath アップロードするファイルのパス。
13 * @return string|null サーバーからのレスポンス文字列、またはエラーが発生した場合はnull。
14 */
15function uploadFileWithPostRequest(string $url, string $filePath): ?string
16{
17    // アップロードするファイルが存在するか確認します。
18    if (!file_exists($filePath)) {
19        echo "エラー: ファイル '{$filePath}' が見つかりません。\n";
20        return null;
21    }
22
23    // ファイルを読み込みモードでオープンします。
24    // CURLOPT_READDATAはファイルハンドル（リソース）を必要とします。
25    $fileHandle = fopen($filePath, 'r');
26    if (!$fileHandle) {
27        echo "エラー: ファイル '{$filePath}' を開けませんでした。\n";
28        return null;
29    }
30
31    // アップロードするファイルのサイズを取得します。
32    // CURLOPT_INFILESIZEは、cURLがアップロードの終了を知るために必要です。
33    $fileSize = filesize($filePath);
34    if ($fileSize === false) {
35        echo "エラー: ファイル '{$filePath}' のサイズを取得できませんでした。\n";
36        fclose($fileHandle);
37        return null;
38    }
39
40    // cURLセッションを初期化します。
41    $ch = curl_init();
42    if (false === $ch) {
43        echo "エラー: cURLの初期化に失敗しました。\n";
44        fclose($fileHandle);
45        return null;
46    }
47
48    // cURLオプションを設定します。
49
50    // リクエストの送信先URL
51    curl_setopt($ch, CURLOPT_URL, $url);
52    // 実行結果を文字列で受け取るように設定
53    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
54
55    // HTTPリクエストメソッドをPOSTに設定します。
56    // CURLOPT_CUSTOMREQUEST を 'POST' に設定することで、CURLOPT_UPLOAD と併用して
57    // ファイルをPOSTリクエストのボディとして送信できます。
58    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
59    // アップロードモードを有効にします。
60    // これにより、cURLはCURLOPT_READDATAからデータを読み取り、リクエストボディとして送信します。
61    curl_setopt($ch, CURLOPT_UPLOAD, true);
62
63    // CURLOPT_READDATA (CURLOPT_INFILEのエイリアス) にファイルハンドルを設定します。
64    // cURLはこのファイルハンドルからアップロードするデータを読み込みます。
65    curl_setopt($ch, CURLOPT_READDATA, $fileHandle);
66
67    // アップロードするファイルのサイズを設定します。
68    // これにより、cURLはContent-Lengthヘッダを正しく設定し、
69    // サーバーがデータの長さを知ることができます。
70    curl_setopt($ch, CURLOPT_INFILESIZE, $fileSize);
71
72    // オプション: タイムアウトを30秒に設定
73    curl_setopt($ch, CURLOPT_TIMEOUT, 30);
74
75    // cURLリクエストを実行し、レスポンスを取得します。
76    $response = curl_exec($ch);
77
78    // エラーが発生したか確認します。
79    if (curl_errno($ch)) {
80        $errorMsg = curl_error($ch);
81        echo "cURLエラー: {$errorMsg}\n";
82        $response = null; // エラー時はnullを返します
83    } else {
84        echo "cURLリクエストが成功しました。\n";
85    }
86
87    // cURLセッションを閉じます。
88    curl_close($ch);
89
90    // オープンしたファイルハンドルを閉じます。
91    fclose($fileHandle);
92
93    return $response;
94}
95
96// --- 使用例 ---
97
98// テスト用のアップロード先URL (例: https://httpbin.org/post はPOSTリクエストの内容を返すサービス)
99$targetUrl = 'https://httpbin.org/post';
100
101// アップロードするダミーファイルを作成します。
102$tempFileName = 'my_document.txt';
103$fileContent = "これはcURLのCURLOPT_READDATAを使ってアップロードされるテストファイルです。\n";
104$fileContent .= "複数行のデータを含めることができます。\n";
105file_put_contents($tempFileName, $fileContent);
106
107echo "ファイル '{$tempFileName}' を '{$targetUrl}' にアップロードします...\n";
108
109// ファイルアップロード関数を呼び出します。
110$result = uploadFileWithPostRequest($targetUrl, $tempFileName);
111
112if ($result !== null) {
113    echo "サーバーからのレスポンス:\n" . $result . "\n";
114} else {
115    echo "ファイルのアップロードに失敗しました。\n";
116}
117
118// 作成したダミーファイルを削除します。
119if (file_exists($tempFileName)) {
120    unlink($tempFileName);
121    echo "一時ファイル '{$tempFileName}' を削除しました。\n";
122}

このサンプルコードは、PHPのcURLライブラリを使用し、CURLOPT_READDATAオプションを活用してHTTP POSTリクエストでファイルをアップロードする方法を初心者向けに解説します。CURLOPT_READDATAは、オープンしたファイルハンドル（ファイルへの参照）をcURLに設定することで、そのファイルの内容をリクエストボディとして直接送信するために利用されるオプションです。これは、一般的なキーバリュー形式のデータではなく、ファイルストリーム全体をPOSTリクエストのボディとしてサーバーに送りたい場合に適しています。

uploadFileWithPostRequest関数は、アップロード先のURLとアップロードするファイルのパス（いずれも文字列）を引数に取ります。この関数を実行すると、サーバーからのレスポンスが文字列として戻り値で返されます。ただし、ファイルが見つからない、ファイルを開けない、cURLの実行中にエラーが発生した場合は、戻り値としてnullが返され、エラーメッセージが出力されます。

関数内部では、まず指定されたファイルを読み込みモードでオープンし、そのファイルハンドルをCURLOPT_READDATAに設定します。また、リクエストメソッドをPOSTに設定するCURLOPT_CUSTOMREQUEST、アップロードモードを有効にするCURLOPT_UPLOAD、アップロードするファイルのサイズを指定するCURLOPT_INFILESIZEといった、ファイルアップロードに必要な他のcURLオプションも適切に設定しています。このコードは、CURLOPT_READDATAを使ったファイルアップロードの具体的な手順と、エラー発生時の適切な対応方法を示しています。