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

Copy
1<?php
2
3/**
4 * CURLOPT_BINARYTRANSFER 定数を使用してURLからバイナリデータを取得し、ファイルに保存するサンプル
5 *
6 * この関数は、指定されたURLからデータをダウンロードし、それをファイルに保存する方法を示します。
7 * CURLOPT_BINARYTRANSFER オプションは、特にテキストモードでの転送で発生する可能性のある
8 * 改行コードの変換を防ぎ、バイナリデータをそのまま転送するために使用されます。
9 *
10 * @param string $url ダウンロードするファイルのURL
11 * @param string $outputPath ダウンロードしたデータを保存するファイルパス
12 * @return bool 成功した場合は true、失敗した場合は false
13 */
14function downloadBinaryFile(string $url, string $outputPath): bool
15{
16    // cURLセッションを初期化
17    $ch = curl_init();
18
19    if ($ch === false) {
20        echo "エラー: cURL初期化に失敗しました。" . PHP_EOL;
21        return false;
22    }
23
24    // cURLオプションを設定
25    curl_setopt($ch, CURLOPT_URL, $url);
26    // 転送結果を文字列として取得するよう設定
27    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
28    // バイナリ転送モードを有効にする
29    // このオプションは、特にテキストモードでの転送で発生する可能性のある改行コードの変換を防ぎ、
30    // バイナリデータをそのまま転送するために使用されます。
31    curl_setopt($ch, CURLOPT_BINARYTRANSFER, true);
32
33    // cURLセッションを実行し、データを取得
34    $data = curl_exec($ch);
35
36    // エラーチェック
37    if (curl_errno($ch)) {
38        echo 'エラー: cURLエラーが発生しました: ' . curl_error($ch) . PHP_EOL;
39        curl_close($ch);
40        return false;
41    }
42
43    // cURLセッションを終了
44    curl_close($ch);
45
46    // データが取得できなかった場合
47    if ($data === false || $data === '') {
48        echo "エラー: URL '{$url}' からデータを取得できませんでした。" . PHP_EOL;
49        return false;
50    }
51
52    // 取得したデータを指定されたファイルパスに保存
53    if (file_put_contents($outputPath, $data) === false) {
54        echo "エラー: ファイル '{$outputPath}' の保存に失敗しました。" . PHP_EOL;
55        return false;
56    }
57
58    return true;
59}
60
61// --- 使用例 ---
62// 実際には存在するバイナリファイル（例: 画像ファイル）のURLを指定してください。
63$exampleUrl = "https://www.php.net/images/logos/php-logo.svg"; // PHPのロゴSVGファイル
64$outputFile = "downloaded_php_logo.svg"; // ダウンロードしたデータを保存するファイル名
65
66echo "--- CURLOPT_BINARYTRANSFER サンプル開始 ---" . PHP_EOL;
67
68if (downloadBinaryFile($exampleUrl, $outputFile)) {
69    echo "成功: ファイルを正常にダウンロードし、'{$outputFile}'として保存しました。" . PHP_EOL;
70} else {
71    echo "失敗: ファイルのダウンロードまたは保存中に問題が発生しました。" . PHP_EOL;
72}
73
74echo "--- CURLOPT_BINARYTRANSFER サンプル終了 ---" . PHP_EOL;
75
76?>

PHPのCURLOPT_BINARYTRANSFERは、cURL拡張機能で使用される定数です。これは、インターネット上のURLからファイルなどのバイナリデータを取得する際に、データが加工されずにそのまま転送されるように設定するために利用されます。特にテキストとバイナリの区別がある環境で、テキストモードでの転送時に発生する可能性のある改行コードの自動変換を防ぎ、画像ファイルや圧縮ファイルなどを正確にダウンロードするために重要です。

提供されたサンプルコードでは、downloadBinaryFile関数が指定されたURLからバイナリファイルをダウンロードし、ローカルに保存する一連の流れを示しています。この関数は、ダウンロード元となるファイルのURLを文字列として受け取り、ダウンロードしたデータを保存するoutputPathを文字列で指定します。処理が成功した場合はtrueを、失敗した場合はfalseをブール値として返します。

サンプルコードでは、curl_setopt($ch, CURLOPT_BINARYTRANSFER, true);と設定することで、cURLがデータをバイナリモードで転送するように指示しています。これにより、curl_exec()で取得されたデータは、改行コードの変換が行われることなく、元の形式を保ったまま取得されます。取得されたデータはfile_put_contents()関数を使って指定されたファイルに書き込まれ、ファイルの破損なく安全にバイナリデータを扱うことが可能です。