CURLFile オブジェクトを作る

# CURLFile::__construct

# curl_file_create

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

CURLFile::__construct -- curl_file_create — CURLFile オブジェクトを作る

### 説明

オブジェクト指向型

public function CURLFile::__construct(string `$filename`, ?string `$mime_type` = `null`, ?string `$posted_filename` = `null`)

手続き型

function curl_file_create(string `$filename`, ?string `$mime_type` = `null`, ?string `$posted_filename` = `null`): CURLFile

CURLFile オブジェクトを作ります。これは、`CURLOPT_POSTFIELDS` でファイルをアップロードするときに使います。

### パラメータ

`filename`

  アップロードするファイルへのパス。

`mime_type`

  ファイルの Mimetype。

`posted_filename`

  アップロードデータの中で使うファイルの名前。

### 戻り値

CURLFile オブジェクトを返します。

### 変更履歴

バージョン | 説明
--- | ---
8.0.0 | `mime_type` と `posted_filename` は nullable になりました。 これより前のバージョンでは、デフォルト値が `0` でした。

### 例

例1 CURLFile::__construct() の例

オブジェクト指向型

    <?php
    /* http://example.com/upload.php:
    <?php var_dump($_FILES); ?>
    */

    // cURL ハンドルを作ります
    $ch = curl_init('http://example.com/upload.php');

    // CURLFile オブジェクトを作ります
    $cfile = new CURLFile('cats.jpg','image/jpeg','test_name');

    // POST データを設定します
    $data = array('test_file' => $cfile);
    curl_setopt($ch, CURLOPT_POST,1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

    // このハンドルを実行します
    curl_exec($ch);
    ?>

手続き型

    <?php
    /* http://example.com/upload.php:
    <?php var_dump($_FILES); ?>
    */

    // cURL ハンドルを作ります
    $ch = curl_init('http://example.com/upload.php');

    // CURLFile オブジェクトを作ります
    $cfile = curl_file_create('cats.jpg','image/jpeg','test_name');

    // POST データを設定します
    $data = array('test_file' => $cfile);
    curl_setopt($ch, CURLOPT_POST,1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

    // このハンドルを実行します
    curl_exec($ch);
    ?>

上の例の出力は以下となります。

    array(1) {
      ["test_file"]=>
      array(5) {
        ["name"]=>
        string(9) "test_name"
        ["type"]=>
        string(10) "image/jpeg"
        ["tmp_name"]=>
        string(14) "/tmp/phpPC9Kbx"
        ["error"]=>
        int(0)
        ["size"]=>
        int(46334)
      }
    }

例2 CURLFile::__construct() で、複数のファイルをアップロードする例

オブジェクト指向型

    <?php
    $request = curl_init('http://www.example.com/upload.php');
    curl_setopt($request, CURLOPT_POST, true);
    curl_setopt($request, CURLOPT_SAFE_UPLOAD, true);
    curl_setopt($request, CURLOPT_POSTFIELDS, [
        'blob[0]' => new CURLFile(realpath('first-file.jpg'), 'image/jpeg'),
        'blob[1]' => new CURLFile(realpath('second-file.txt'), 'text/plain'),
        'blob[2]' => new CURLFile(realpath('third-file.exe'), 'application/octet-stream'),
    ]);
    curl_setopt($request, CURLOPT_RETURNTRANSFER, true);

    echo curl_exec($request);

    var_dump(curl_getinfo($request));

手続き型

    <?php
    // procedural
    $request = curl_init('http://www.example.com/upload.php');
    curl_setopt($request, CURLOPT_POST, true);
    curl_setopt($request, CURLOPT_SAFE_UPLOAD, true);
    curl_setopt($request, CURLOPT_POSTFIELDS, [
        'blob[0]' => curl_file_create(realpath('first-file.jpg'), 'image/jpeg'),
        'blob[1]' => curl_file_create(realpath('second-file.txt'), 'text/plain'),
        'blob[2]' => curl_file_create(realpath('third-file.exe'), 'application/octet-stream'),
    ]);
    curl_setopt($request, CURLOPT_RETURNTRANSFER, true);

    echo curl_exec($request);

    var_dump(curl_getinfo($request));

上の例の出力は以下となります。

    array(26) {
      ["url"]=>
      string(31) "http://www.example.com/upload.php"
      ["content_type"]=>
      string(24) "text/html; charset=UTF-8"
      ["http_code"]=>
      int(200)
      ["header_size"]=>
      int(198)
      ["request_size"]=>
      int(196)
      ["filetime"]=>
      int(-1)
      ["ssl_verify_result"]=>
      int(0)
      ["redirect_count"]=>
      int(0)
      ["total_time"]=>
      float(0.060062)
      ["namelookup_time"]=>
      float(0.028575)
      ["connect_time"]=>
      float(0.029011)
      ["pretransfer_time"]=>
      float(0.029121)
      ["size_upload"]=>
      float(3230730)
      ["size_download"]=>
      float(811)
      ["speed_download"]=>
      float(13516)
      ["speed_upload"]=>
      float(53845500)
      ["download_content_length"]=>
      float(811)
      ["upload_content_length"]=>
      float(3230730)
      ["starttransfer_time"]=>
      float(0.030355)
      ["redirect_time"]=>
      float(0)
      ["redirect_url"]=>
      string(0) ""
      ["primary_ip"]=>
      string(13) "0.0.0.0"
      ["certinfo"]=>
      array(0) {
      }
      ["primary_port"]=>
      int(80)
      ["local_ip"]=>
      string(12) "0.0.0.0"
      ["local_port"]=>
      int(34856)
    }

### 参考

- curl_setopt() - cURL 転送用オプションを設定する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open