mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-04-01 08:48:56 +00:00
db870c9481
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351642 c90b9560-bf6c-de11-be94-00142212c4b1
306 lines
7.6 KiB
XML
306 lines
7.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="curlfile.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>CURLFile::__construct</refname>
|
|
<refname>curl_file_create</refname>
|
|
<refpurpose>Create a CURLFile object</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>&style.oop;</para>
|
|
<constructorsynopsis>
|
|
<modifier>public</modifier> <methodname>CURLFile::__construct</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>mime_type</parameter><initializer>&null;</initializer></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>posted_filename</parameter><initializer>&null;</initializer></methodparam>
|
|
</constructorsynopsis>
|
|
<para>&style.procedural;</para>
|
|
<methodsynopsis role="procedural">
|
|
<type>CURLFile</type><methodname>curl_file_create</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>mime_type</parameter><initializer>&null;</initializer></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>posted_filename</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Creates a <classname>CURLFile</classname> object, used to upload a file with <constant>CURLOPT_POSTFIELDS</constant>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>filename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Path to the file which will be uploaded.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mime_type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Mimetype of the file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>posted_filename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the file to be used in the upload data.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a <classname>CURLFile</classname> object.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
<parameter>mime_type</parameter> and <parameter>posted_filename</parameter>
|
|
are nullable now; previously their default was <literal>0</literal>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>CURLFile::__construct</function> example</title>
|
|
<para>&style.oop;</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>&style.procedural;</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
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)
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title><function>CURLFile::__construct</function> uploading multiple files example</title>
|
|
<para>&style.oop;</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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);
|
|
]]>
|
|
</programlisting>
|
|
<para>&style.procedural;</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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);
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
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)
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>curl_setopt</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|