curl-setopt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d3cf0dbf9bc908100103917f8485581c50bd36b Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.curl-setopt" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_setopt</refname>
  <refpurpose>设置 cURL 传输选项</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>curl_setopt</methodname>
   <methodparam><type>CurlHandle</type><parameter>handle</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   为 cURL 会话句柄设置选项。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.ch.description;
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       需要设置的 <constant>CURLOPT_<replaceable>*</replaceable></constant> 选项。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       将设置在 <parameter>option</parameter> 选项上的值。有关每个常量期望的值类型的详情，请参阅
       <constant>CURLOPT_<replaceable>*</replaceable></constant> 常量的描述。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.4.0</entry>
       <entry>
        <constant>CURLOPT_DNS_USE_GLOBAL_CACHE</constant> 
        不再有任何效果，并且在线程安全 PHP 上启用不再触发警告。
       </entry>
      </row>
      &curl.changelog.handle-param;
      <row>
       <entry>7.3.15、7.4.3</entry>
       <entry>
        引入 <constant>CURLOPT_HTTP09_ALLOWED</constant>。
       </entry>
      </row>
      <row>
       <entry>7.3.0</entry>
       <entry>
        引入 <constant>CURLOPT_ABSTRACT_UNIX_SOCKET</constant>、<constant>CURLOPT_KEEP_SENDING_ON_ERROR</constant>、<constant>CURLOPT_PRE_PROXY</constant>、<constant>CURLOPT_PROXY_CAINFO</constant>、<constant>CURLOPT_PROXY_CAPATH</constant>、<constant>CURLOPT_PROXY_CRLFILE</constant>、<constant>CURLOPT_PROXY_KEYPASSWD</constant>、<constant>CURLOPT_PROXY_PINNEDPUBLICKEY</constant>、<constant>CURLOPT_PROXY_SSLCERT</constant>、<constant>CURLOPT_PROXY_SSLCERTTYPE</constant>、<constant>CURLOPT_PROXY_SSL_CIPHER_LIST</constant>、<constant>CURLOPT_PROXY_SSLKEY</constant>、<constant>CURLOPT_PROXY_SSLKEYTYPE</constant>、<constant>CURLOPT_PROXY_SSL_OPTIONS</constant>、<constant>CURLOPT_PROXY_SSL_VERIFYHOST</constant>、<constant>CURLOPT_PROXY_SSL_VERIFYPEER</constant>、<constant>CURLOPT_PROXY_SSLVERSION</constant>、<constant>CURLOPT_PROXY_TLSAUTH_PASSWORD</constant>、<constant>CURLOPT_PROXY_TLSAUTH_TYPE</constant>、<constant>CURLOPT_PROXY_TLSAUTH_USERNAME</constant>、<constant>CURLOPT_SOCKS5_AUTH</constant>、<constant>CURLOPT_SUPPRESS_CONNECT_HEADERS</constant>、<constant>CURLOPT_DISALLOW_USERNAME_IN_URL</constant>、<constant>CURLOPT_DNS_SHUFFLE_ADDRESSES</constant>、<constant>CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS</constant>、<constant>CURLOPT_HAPROXYPROTOCOL</constant>、<constant>CURLOPT_PROXY_TLS13_CIPHERS</constant>、<constant>CURLOPT_SSH_COMPRESSION</constant>、<constant>CURLOPT_TIMEVALUE_LARGE</constant>
        和 <constant>CURLOPT_TLS13_CIPHERS</constant>。
       </entry>
      </row>
      <row>
       <entry>7.0.7</entry>
       <entry>
        引入 <constant>CURL_HTTP_VERSION_2</constant>、<constant>CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE</constant>、
        <constant>CURL_HTTP_VERSION_2TLS</constant>、<constant>CURL_REDIR_POST_301</constant>、
        <constant>CURL_REDIR_POST_302</constant>、<constant>CURL_REDIR_POST_303</constant>、
        <constant>CURL_REDIR_POST_ALL</constant>、<constant>CURL_VERSION_KERBEROS5</constant>、
        <constant>CURL_VERSION_PSL</constant>、<constant>CURL_VERSION_UNIX_SOCKETS</constant>、
        <constant>CURLAUTH_NEGOTIATE</constant>、<constant>CURLAUTH_NTLM_WB</constant>、
        <constant>CURLFTP_CREATE_DIR</constant>、<constant>CURLFTP_CREATE_DIR_NONE</constant>、
        <constant>CURLFTP_CREATE_DIR_RETRY</constant>、<constant>CURLHEADER_SEPARATE</constant>、
        <constant>CURLHEADER_UNIFIED</constant>、<constant>CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE</constant>、
        <constant>CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE</constant>、<constant>CURLMOPT_MAX_HOST_CONNECTIONS</constant>、
        <constant>CURLMOPT_MAX_PIPELINE_LENGTH</constant>、<constant>CURLMOPT_MAX_TOTAL_CONNECTIONS</constant>、
        <constant>CURLOPT_CONNECT_TO</constant>、<constant>CURLOPT_DEFAULT_PROTOCOL</constant>、
        <constant>CURLOPT_DNS_INTERFACE</constant>、<constant>CURLOPT_DNS_LOCAL_IP4</constant>、
        <constant>CURLOPT_DNS_LOCAL_IP6</constant>、<constant>CURLOPT_EXPECT_100_TIMEOUT_MS</constant>、
        <constant>CURLOPT_HEADEROPT</constant>、<constant>CURLOPT_LOGIN_OPTIONS</constant>、
        <constant>CURLOPT_PATH_AS_IS</constant>、<constant>CURLOPT_PINNEDPUBLICKEY</constant>、
        <constant>CURLOPT_PIPEWAIT</constant>、<constant>CURLOPT_PROXY_SERVICE_NAME</constant>、
        <constant>CURLOPT_PROXYHEADER</constant>、<constant>CURLOPT_SASL_IR</constant>、
        <constant>CURLOPT_SERVICE_NAME</constant>、<constant>CURLOPT_SSL_ENABLE_ALPN</constant>、
        <constant>CURLOPT_SSL_ENABLE_NPN</constant>、<constant>CURLOPT_SSL_FALSESTART</constant>、
        <constant>CURLOPT_SSL_VERIFYSTATUS</constant>、<constant>CURLOPT_STREAM_WEIGHT</constant>、
        <constant>CURLOPT_TCP_FASTOPEN</constant>、<constant>CURLOPT_TFTP_NO_OPTIONS</constant>、
        <constant>CURLOPT_UNIX_SOCKET_PATH</constant>、<constant>CURLOPT_XOAUTH2_BEARER</constant>、
        <constant>CURLPROTO_SMB</constant>、<constant>CURLPROTO_SMBS</constant>、
        <constant>CURLPROXY_HTTP_1_0</constant>、<constant>CURLSSH_AUTH_AGENT</constant> 和
        <constant>CURLSSLOPT_NO_REVOKE</constant>。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>初始化一个新的cURL会话并获取一个网页</title>
    <programlisting role="php">
<![CDATA[
<?php
// 创建一个新cURL资源
$ch = curl_init();

// 设置URL和相应的选项
curl_setopt($ch, CURLOPT_URL, "http://www.example.com/");
curl_setopt($ch, CURLOPT_HEADER, false);

// 抓取URL并把它传递给浏览器
curl_exec($ch);

//关闭cURL资源，并且释放系统资源
curl_close($ch);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    传递一个数组到<constant>CURLOPT_POSTFIELDS</constant>，cURL会把数据编码成
    <emphasis>multipart/form-data</emphasis>，而然传递一个URL-encoded字符串时，数据会被编码成
    <emphasis>application/x-www-form-urlencoded</emphasis>。
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>curl_setopt_array</function></member>
    <member><classname>CURLFile</classname></member>
    <member><classname>CURLStringFile</classname></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
-->