CURLFile::__construct

curl_file_create

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

CURLFile::__construct -- curl_file_createCreate a CURLFile object

Description

Object-oriented style

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

Procedural style

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

Creates a CURLFile object, used to upload a file with CURLOPT_POSTFIELDS .

Parameters

filename

Path to the file which will be uploaded.

mime_type

Mimetype of the file.

posted_filename

Name of the file to be used in the upload data.

Return Values

Returns a CURLFile object.

Changelog

Version Description
8.0.0 mime_type and posted_filename are nullable now; previously their default was 0.

Examples

Example #1 CURLFile::__construct() example

Object-oriented style

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

// Create a cURL handle
$ch = curl_init('http://example.com/upload.php');

// Create a CURLFile object
$cfile = new CURLFile('cats.jpg','image/jpeg','test_name');

// Assign POST data
$data = array('test_file' => $cfile);
curl_setopt($ch, CURLOPT_POST,1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

// Execute the handle
curl_exec($ch);
?>

Procedural style

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

// Create a cURL handle
$ch = curl_init('http://example.com/upload.php');

// Create a CURLFile object
$cfile = curl_file_create('cats.jpg','image/jpeg','test_name');

// Assign POST data
$data = array('test_file' => $cfile);
curl_setopt($ch, CURLOPT_POST,1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

// Execute the handle
curl_exec($ch);
?>

The above example will output:

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)
 }
}

Example #2 CURLFile::__construct() uploading multiple files example

Object-oriented style

<?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));

curl_close($request);

Procedural style

<?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));

curl_close($request);

The above example will output:

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)
}

See Also

Found A Problem?

Learn How To Improve This PageSubmit a Pull RequestReport a Bug
+add a note

User Contributed Notes 2 notes

up
7
CertaiN
11 years ago
There are "@" issue on multipart POST requests.

Solution for PHP 5.5 or later:
- Enable CURLOPT_SAFE_UPLOAD.
- Use CURLFile instead of "@".

Solution for PHP 5.4 or earlier:
- Build up multipart content body by youself.
- Change "Content-Type" header by yourself.

The following snippet will help you :D

<?php

/**
* For safe multipart POST request for PHP5.3 ~ PHP 5.4.
*
* @param resource $ch cURL resource
* @param array $assoc "name => value"
* @param array $files "name => path"
* @return bool
*/
function curl_custom_postfields($ch, array $assoc = array(), array $files = array()) {

// invalid characters for "name" and "filename"
static $disallow = array("0円", "\"", "\r", "\n");

// build normal parameters
foreach ($assoc as $k => $v) {
$k = str_replace($disallow, "_", $k);
$body[] = implode("\r\n", array(
"Content-Disposition: form-data; name=\"{$k}\"",
"",
filter_var($v),
));
}

// build file parameters
foreach ($files as $k => $v) {
switch (
true) {
case
false === $v = realpath(filter_var($v)):
case !
is_file($v):
case !
is_readable($v):
continue;
// or return false, throw new InvalidArgumentException
}
$data = file_get_contents($v);
$v = call_user_func("end", explode(DIRECTORY_SEPARATOR, $v));
$k = str_replace($disallow, "_", $k);
$v = str_replace($disallow, "_", $v);
$body[] = implode("\r\n", array(
"Content-Disposition: form-data; name=\"{$k}\"; filename=\"{$v}\"",
"Content-Type: application/octet-stream",
"",
$data,
));
}

// generate safe boundary
do {
$boundary = "---------------------" . md5(mt_rand() . microtime());
} while (
preg_grep("/{$boundary}/", $body));

// add boundary for each parameters
array_walk($body, function (&$part) use ($boundary) {
$part = "--{$boundary}\r\n{$part}";
});

// add final boundary
$body[] = "--{$boundary}--";
$body[] = "";

// set options
return @curl_setopt_array($ch, array(
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => implode("\r\n", $body),
CURLOPT_HTTPHEADER => array(
"Expect: 100-continue",
"Content-Type: multipart/form-data; boundary={$boundary}", // change Content-Type
),
));
}

?>
up
-5
mipa
11 years ago
For PHP < 5.5:

<?php

if (!function_exists('curl_file_create')) {
function
curl_file_create($filename, $mimetype = '', $postname = '') {
return
"@$filename;filename="
. ($postname ?: basename($filename))
. (
$mimetype ? ";type=$mimetype" : '');
}
}

?>
+add a note

AltStyle によって変換されたページ (->オリジナル) /