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

Copy
1<?php
2
3/**
4 * 指定されたURLからファイルをダウンロードし、指定されたファイルパスに保存します。
5 * CURLOPT_FILE オプションを使用することで、受信したデータを直接ファイルに書き込みます。
6 * これは、大きなファイルのダウンロードや、メモリに一時的にデータを保持したくない場合に特に有用です。
7 *
8 * @param string $url ダウンロードするファイルのURL
9 * @param string $savePath ファイルを保存するローカルパス
10 * @return bool 成功した場合はtrue、失敗した場合はfalse
11 */
12function downloadFileWithCurlOptFile(string $url, string $savePath): bool
13{
14    // 1. cURLセッションを初期化します。
15    $ch = curl_init();
16
17    // cURLの初期化に失敗した場合、エラーをログに記録し、falseを返します。
18    if ($ch === false) {
19        error_log("cURLセッションの初期化に失敗しました。");
20        return false;
21    }
22
23    // 2. 受信データを書き込むためのファイルを開きます。
24    // 'wb' モードはバイナリ書き込みモードで、クロスプラットフォームで安全です。
25    $fp = fopen($savePath, 'wb');
26
27    // ファイルのオープンに失敗した場合、エラーをログに記録し、cURLセッションを閉じてfalseを返します。
28    if ($fp === false) {
29        error_log("ファイル '{$savePath}' を開けませんでした。書き込みパーミッションを確認してください。");
30        curl_close($ch);
31        return false;
32    }
33
34    // 3. cURLオプションを設定します。
35    curl_setopt($ch, CURLOPT_URL, $url);                 // ダウンロード対象のURL
36    curl_setopt($ch, CURLOPT_FILE, $fp);                 // ★受信データを直接書き込むファイルポインタを設定★
37    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);      // サーバーからのリダイレクトを自動的に追跡します。
38    curl_setopt($ch, CURLOPT_FAILONERROR, true);         // HTTPステータスコードが400以上の場合、cURLエラーとみなします。
39
40    // 4. cURLセッションを実行し、ファイルダウンロードを開始します。
41    $success = curl_exec($ch);
42
43    // cURL実行中にエラーが発生した場合、エラーをログに記録します。
44    if ($success === false) {
45        error_log("cURL実行中にエラーが発生しました: " . curl_error($ch));
46    }
47
48    // 5. 開いたファイルポインタを閉じます。
49    fclose($fp);
50
51    // 6. cURLセッションを閉じ、リソースを解放します。
52    curl_close($ch);
53
54    // ダウンロードの成否をブール値で返します。
55    return (bool) $success;
56}
57
58// -----------------------------------------------------------------------------
59// サンプル使用例
60// -----------------------------------------------------------------------------
61
62// ダウンロードするファイルのURLを指定します。
63// 例として、GitHub上のPHPプロジェクトのREADME.mdファイルを使用します。
64$downloadUrl = 'https://raw.githubusercontent.com/php/php-src/master/README.md';
65
66// ダウンロードしたファイルを保存するローカルパスを指定します。
67// __DIR__ は現在のスクリプトがあるディレクトリを指します。
68$saveFilePath = __DIR__ . '/downloaded_php_readme.md';
69
70echo "URL: {$downloadUrl} からファイルをダウンロードしようとしています...\n";
71echo "保存先: {$saveFilePath}\n";
72
73// ファイルダウンロード関数を実行し、結果を表示します。
74if (downloadFileWithCurlOptFile($downloadUrl, $saveFilePath)) {
75    echo "ファイルのダウンロードに成功しました。\n";
76    // ダウンロードされたファイルのサイズを確認します。
77    if (file_exists($saveFilePath)) {
78        echo "ダウンロードされたファイルのサイズ: " . filesize($saveFilePath) . " バイト\n";
79    }
80} else {
81    echo "ファイルのダウンロードに失敗しました。\n";
82}
83
84// 必要に応じて、ダウンロードしたファイルを削除するクリーンアップ処理
85// if (file_exists($saveFilePath)) {
86//     unlink($saveFilePath);
87//     echo "ダウンロードしたファイルを削除しました。\n";
88// }

このサンプルコードは、PHPのcURLライブラリを使って指定されたURLからファイルをダウンロードし、ローカルに保存する方法を説明しています。特にCURLOPT_FILEというオプションが重要で、これはcURLが受信したデータをメモリに一時的に保持せず、直接指定されたファイルに書き込むように指示する役割を持ちます。この機能は、サイズの大きなファイルをダウンロードする際にメモリの消費を抑え、処理を効率化できるため、非常に有用です。

downloadFileWithCurlOptFile関数は、ダウンロードするファイルのURLを$url、保存先のローカルパスを$savePathとして受け取ります。関数内では、まずcURLセッションを初期化し、次に受信データを書き込むためのファイルをオープンします。その後、CURLOPT_URLでダウンロード元のURLを設定し、CURLOPT_FILEに先ほど開いたファイルのポインタ（ファイルへの参照）を設定します。これにより、cURLはダウンロード中に受信したデータを直接そのファイルへ書き込みます。リダイレクトの自動追跡やHTTPエラーの検出などのオプションも設定されています。ダウンロードが完了すると、開いたファイルとcURLセッションは閉じられ、リソースが解放されます。この関数の戻り値は、ファイルのダウンロードが成功した場合はtrue、失敗した場合はfalseとなります。この実装により、メモリ効率の良い堅牢なファイルダウンロード処理を実現できます。

Copy
1<?php
2
3/**
4 * 指定されたURLの内容をファイルにダウンロードします。
5 *
6 * @param string $url ダウンロードするファイルのURL。
7 * @param string $filePath 保存先のファイルパス。
8 * @return bool ダウンロードが成功した場合はtrue、失敗した場合はfalse。
9 */
10function downloadUrlToFile(string $url, string $filePath): bool
11{
12    // ファイルを書き込みモードで開きます。ファイルが存在しない場合は作成されます。
13    // 'w' は既存のファイル内容を上書きします。
14    $fileHandle = fopen($filePath, 'w');
15    if ($fileHandle === false) {
16        error_log("ファイルのオープンに失敗しました: {$filePath}");
17        return false;
18    }
19
20    // cURLセッションを初期化します。
21    $ch = curl_init();
22    if ($ch === false) {
23        error_log("cURLの初期化に失敗しました。");
24        fclose($fileHandle);
25        return false;
26    }
27
28    // cURLオプションを設定します。
29    // CURLOPT_URL: 取得するURLを指定します。
30    curl_setopt($ch, CURLOPT_URL, $url);
31
32    // CURLOPT_FILE: ダウンロードしたデータを書き込むファイルポインタを指定します。
33    // この定数が今回のキーワードです。
34    curl_setopt($ch, CURLOPT_FILE, $fileHandle);
35
36    // CURLOPT_HEADER: レスポンスヘッダーをダウンロード結果に含めないようにします。
37    curl_setopt($ch, CURLOPT_HEADER, false);
38
39    // CURLOPT_FOLLOWLOCATION: HTTPリダイレクトがあった場合に自動的に追跡します。
40    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
41
42    // CURLOPT_FAILONERROR: HTTPステータスコードが400以上の場合にエラーを返します。
43    curl_setopt($ch, CURLOPT_FAILONERROR, true);
44
45    // cURLセッションを実行し、ファイルをダウンロードします。
46    $result = curl_exec($ch);
47
48    // エラーがある場合はログに記録します。
49    if ($result === false) {
50        error_log("cURLエラーが発生しました: " . curl_error($ch));
51    }
52
53    // cURLセッションを閉じます。
54    curl_close($ch);
55
56    // ファイルポインタを閉じます。
57    fclose($fileHandle);
58
59    return $result !== false;
60}
61
62// --- サンプル使用例 ---
63// ダウンロードしたいURL
64$targetUrl = 'http://example.com/';
65// 保存先のファイルパス
66$outputFilePath = __DIR__ . '/example_page.html';
67
68echo "URL: {$targetUrl} をファイル: {$outputFilePath} にダウンロードしようとしています。\n";
69
70if (downloadUrlToFile($targetUrl, $outputFilePath)) {
71    echo "ダウンロードが成功しました。\n";
72    echo "ファイルは {$outputFilePath} に保存されました。\n";
73    // ダウンロードしたファイルの内容を少し表示する例（オプション）
74    // echo "\nファイル内容の最初の100文字:\n";
75    // echo substr(file_get_contents($outputFilePath), 0, 100) . "...\n";
76} else {
77    echo "ダウンロードに失敗しました。\n";
78}
79
80// 作成されたファイルを削除する（クリーンアップ）
81// if (file_exists($outputFilePath)) {
82//     unlink($outputFilePath);
83//     echo "一時ファイル {$outputFilePath} を削除しました。\n";
84// }
85
86?>

このサンプルコードは、指定されたURLのコンテンツを読み込み、その内容をローカルファイルに保存するdownloadUrlToFile関数を定義しています。

この関数は、ダウンロードしたいウェブページのURLを示す文字列$urlと、ダウンロードした内容を保存する先のファイルパスを示す文字列$filePathの二つの引数を受け取ります。処理が成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。

関数内では、まずfopen関数を使って保存先のファイルを書き込みモードで開きます。これは、ダウンロードしたデータを受け取るための準備です。次に、curl_init関数でcURLセッションを開始し、ウェブからのデータ取得に関する設定を行います。

ここで重要なのが、CURLOPT_FILE定数を使用した設定です。curl_setopt($ch, CURLOPT_FILE, $fileHandle);と記述することで、cURLがダウンロードしたデータを直接、fopenで開いたファイルポインタ（$fileHandle）に書き込むように指示しています。これにより、ダウンロードされたデータがPHPのメモリ上に一時的に保持されることなく、効率的にファイルへ保存されます。

その他にも、CURLOPT_URLでダウンロード元のURLを指定したり、CURLOPT_FOLLOWLOCATIONでHTTPリダイレクトを自動的に追跡する設定、CURLOPT_FAILONERRORでHTTPステータスコードがエラーを示す場合に処理を中断する設定などを行っています。

これらの設定後、curl_exec関数で実際のダウンロード処理を実行し、結果に基づいて関数の戻り値を判定します。最後に、curl_closeでcURLセッションを閉じ、fcloseでファイルポインタを閉じて使用したリソースを解放します。このコードは、ウェブ上のファイルを直接ディスクに保存したい場合に非常に役立つ基本的なパターンを示しています。