【PHP8.x】curl_file_create関数の使い方

<?php

/**
 * curl_file_createを使用してファイルをアップロードするサンプル関数
 *
 * この関数は、ローカルに一時ファイルを作成し、
 * curl_file_createでCURLFileオブジェクトを生成して、
 * httpbin.orgのPOSTエンドポイントにファイルをアップロードします。
 * 実行後、レスポンス内容を表示し、一時ファイルを削除します。
 *
 * @return void
 */
function uploadFileExample(): void
{
    // アップロード先のURL (受信したリクエスト情報をJSONで返すサービス)
    $targetUrl = 'https://httpbin.org/post';

    // アップロードするダミーファイルを作成
    $dummyFilePath = __DIR__ . '/upload_test.txt';
    $dummyFileContent = 'これはcurl_file_createのテスト用ファイルです。';
    file_put_contents($dummyFilePath, $dummyFileContent);

    echo "一時ファイルを作成しました: {$dummyFilePath}" . PHP_EOL;

    try {
        // 1. CURLFileオブジェクトの作成
        // curl_file_create(ファイルのパス, MIMEタイプ, サーバー側で認識されるファイル名)
        $cfile = curl_file_create(
            $dummyFilePath,
            'text/plain',
            'sample.txt'
        );

        // 2. POSTデータの設定
        // 'file_field' がHTMLの <input type="file" name="file_field"> のnameに相当します。
        $postData = [
            'file_field' => $cfile,
            'user_name' => 'Taro Yamada',
            'user_id' => '12345',
        ];

        // 3. cURLセッションの初期化と設定
        $ch = curl_init();
        curl_setopt_array($ch, [
            CURLOPT_URL => $targetUrl,
            CURLOPT_RETURNTRANSFER => true, // 結果を文字列で返す
            CURLOPT_POST => true,           // POSTリクエストを指定
            CURLOPT_POSTFIELDS => $postData,    // POSTデータを設定
            CURLOPT_SAFE_UPLOAD => true,    // PHP 5.6.0以降ではデフォルトでtrue
        ]);

        // 4. cURLリクエストの実行
        echo "ファイルをアップロードしています..." . PHP_EOL;
        $response = curl_exec($ch);

        // 5. エラーチェック
        if (curl_errno($ch)) {
            echo 'cURLエラー: ' . curl_error($ch) . PHP_EOL;
        } else {
            // 6. 結果の表示
            echo "サーバーからのレスポンス:" . PHP_EOL;
            // httpbin.orgはJSONを返すので、見やすく整形して表示
            $responseData = json_decode($response, true);
            echo json_encode($responseData, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . PHP_EOL;
        }

        // 7. cURLセッションの終了
        curl_close($ch);

    } finally {
        // 8. 作成した一時ファイルを削除
        if (file_exists($dummyFilePath)) {
            unlink($dummyFilePath);
            echo "一時ファイルを削除しました: {$dummyFilePath}" . PHP_EOL;
        }
    }
}

// 関数を実行
uploadFileExample();

curl_file_create関数は、PHPのcURL機能を使ってファイルをアップロードする際に、アップロード対象のファイル情報をまとめたCURLFileオブジェクトを生成するために使用します。これにより、安全なファイルアップロード処理を実現できます。

関数の第一引数$filenameには、アップロードしたいファイルのローカルパスを文字列で指定します。第二引数$mime_typeには、'text/plain'のようなファイルのMIMEタイプを、第三引数$posted_filenameには、サーバー側で認識させたいファイル名を指定します。後ろ2つの引数は省略可能です。

このサンプルコードでは、まずテスト用のテキストファイルを一時的に作成します。次にcurl_file_createを使い、そのファイルのパス、MIMEタイプ、サーバー側でのファイル名を指定してCURLFileオブジェクトを生成しています。このオブジェクトを、他の送信データ（ユーザー名など）と一緒に配列に格納し、curl_setopt関数のCURLOPT_POSTFIELDSオプションに設定することで、ファイルを含むPOSTリクエストを送信します。リクエスト実行後は、サーバーからの応答を表示し、最後に作成した一時ファイルを削除して処理を終えます。