Book/curl-Phpdoc专题

Client URL 库

简介
安装／配置
预定义常量
范例
- curl 基础例子
cURL 函数
- curl_close — 关闭 cURL 会话
- curl_copy_handle — 复制一个cURL句柄和它的所有选项
- curl_errno — 返回最后一次的错误代码
- curl_error — 返回当前会话最后一次错误的字符串
- curl_escape — 使用 URL 编码给定的字符串
- curl_exec — 执行 cURL 会话
- curl_file_create — 创建一个 CURLFile 对象
- curl_getinfo — 获取一个cURL连接资源句柄的信息
- curl_init — 初始化 cURL 会话
- curl_multi_add_handle — 向curl批处理会话中添加单独的curl句柄
- curl_multi_close — 关闭一组cURL句柄
- curl_multi_errno — 返回上一次 curl 批处理的错误码
- curl_multi_exec — 运行当前 cURL 句柄的子连接
- curl_multi_getcontent — 如果设置了CURLOPT_RETURNTRANSFER，则返回获取的输出的文本流
- curl_multi_info_read — 获取当前解析的cURL的相关传输信息
- curl_multi_init — 返回一个新cURL批处理句柄
- curl_multi_remove_handle — 移除cURL批处理句柄资源中的某个句柄资源
- curl_multi_select — 等待所有cURL批处理中的活动连接
- curl_multi_setopt — 为 cURL 并行处理设置一个选项
- curl_multi_strerror — 返回字符串描述的错误代码
- curl_pause — 暂停和取消暂停一个连接。
- curl_reset — 重置一个 libcurl 会话句柄的所有的选项
- curl_setopt_array — 为 cURL 传输会话批量设置选项
- curl_setopt — 设置 cURL 传输选项
- curl_share_close — 关闭 cURL 共享句柄
- curl_share_errno — 返回共享 curl 句柄的最后一次错误号
- curl_share_init — 初始化一个 cURL 共享句柄。
- curl_share_setopt — 为 cURL 共享句柄设置选项。
- curl_share_strerror — 返回错误号对应的错误消息
- curl_strerror — 返回错误代码的字符串描述
- curl_unescape — 解码给定的 URL 编码的字符串
- curl_version — 获取 cURL 版本信息
CURLFile — CURLFile 类
- CURLFile::__construct — 创建 CURLFile 对象
- CURLFile::getFilename — 获取被上传文件的文件名
- CURLFile::getMimeType — 获取被上传文件的 MIME 类型
- CURLFile::getPostFilename — 获取 POST 请求时使用的文件名
- CURLFile::setMimeType — 设置被上传文件的 MIME 类型
- CURLFile::setPostFilename — 设置 POST 请求时使用的文件名

简介

CURLFile 应该与选项 CURLOPT_POSTFIELDS 一同使用用于上传文件。

类摘要

CURLFile

class CURLFile {

/* 属性 */

public $name ;

public $mime ;

public $postname ;

/* 方法 */

public __construct ( string $filename [, string $mimetype [, string $postname ]] )

public string getFilename ( void )

public string getMimeType ( void )

public string getPostFilename ( void )

public void setMimeType ( string $mime )

public void setPostFilename ( string $postname )

}

属性

name
待上传文件的名称

mime
文件的 MIME type（默认是application/octet-stream）。

postname
上传数据中的文件名称（默认为属性 name ）。

参见

curl_setopt

CURLFile::__construct

curl_file_create

创建 CURLFile 对象

说明

面向对象风格

public CURLFile::__construct ( string $filename [, string $mimetype [, string $postname ]] )

过程化风格

CURLFile curl_file_create ( string $filename [, string $mimetype [, string $postname ]] )

创建 CURLFile 对象，使用 CURLOPT_POSTFIELDS 选项上传文件。

参数

filename
被上传文件的路径。

mimetype
被上传文件的 MIME 类型。

postname
上传数据里面的文件名。

返回值

返回 CURLFile 对象。

范例

示例 #1 CURLFile::__construct 示例

面向对象风格

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

过程化风格

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

以上例程会输出：

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

参见

curl_setopt