<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/context.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'context.http.php',
    1 => 'HTTP context 选项',
    2 => 'HTTP context 的选项列表',
  ),
  'up' => 
  array (
    0 => 'context.php',
    1 => '上下文（Context）选项和参数',
  ),
  'prev' => 
  array (
    0 => 'context.socket.php',
    1 => '套接字上下文选项',
  ),
  'next' => 
  array (
    0 => 'context.ftp.php',
    1 => 'FTP 上下文选项',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'language/context/http.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="context.http" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">HTTP context 选项</h1>
  <p class="refpurpose"><span class="refname">HTTP context 选项</span> &mdash; <span class="dc-title">HTTP context 的选项列表</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-context.http-description">
  <h3 class="title">说明</h3>
  <p class="para">
   提供给 <code class="literal">http://</code> 和 <code class="literal">https://</code> 传输协议的 context 选项。
   transports.
  </p>
 </div>


 <div class="refsect1 options" id="refsect1-context.http-options">
  <h3 class="title">可选项</h3>
  <p class="para">
   <dl>
    
     <dt id="context.http.method">
      <code class="parameter">method</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       远程服务器支持的 <strong><code>GET</code></strong>，<strong><code>POST</code></strong> 或其它 HTTP 方法。
      </p>
      <p class="para">
       默认值是 <strong><code>GET</code></strong>。
      </p>
     </dd>
    
    
     <dt id="context.http.header">
      <code class="parameter">header</code>
      <span class="type"><a href="language.types.array.php" class="type array">array</a></span> 或 <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       请求期间发送的附加 header 。此选项中的值将覆盖其他值
       （如 <code class="literal">User-agent:</code>， <code class="literal">Host:</code> 和 
        <code class="literal">Authentication:</code>)，
        即使在执行 <code class="literal">Location:</code> 重定向时也是如此。
        所以，如果启用了 <code class="parameter">follow_location</code>
        就不建议设置 <code class="literal">Host:</code> header。
      </p>
      <p class="para">
       字符串值是以 <code class="literal">\r\n</code> 分隔的 <code class="literal">Key: value</code>，例如 <code class="literal">&quot;Content-Type:
       application/json\r\nConnection: close&quot;</code>。数组值应为 <code class="literal">Key: value</code>
       的列表，例如 <code class="literal">[&quot;Content-Type: application/json&quot;, &quot;Connection: close&quot;]</code>。
      </p>
     </dd>
    
    
     <dt id="context.http.user-agent">
      <code class="parameter">user_agent</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       要发送的 header <code class="literal">User-Agent:</code> 的值。如果在上面的 
       <code class="literal">header</code> context 选项中没有指定 user-agent，此值将被使用。
      </p>
      <p class="para">
       默认使用 <var class="filename">php.ini</var>  中设置的 <a href="filesystem.configuration.php#ini.user-agent" class="link">user_agent</a>。
      </p>
     </dd>
    
    
     <dt id="context.http.content">
      <code class="parameter">content</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       在 header 后面要发送的额外数据。通常使用POST或PUT请求。
      </p>
     </dd>
    
    
     <dt id="context.http.proxy">
      <code class="parameter">proxy</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       URI 指定的代理服务器的地址（例如：
       <code class="literal">tcp://proxy.example.com:5100</code>）。
      </p>
     </dd>
    
    
     <dt id="context.http.request-fulluri">
      <code class="parameter">request_fulluri</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       当设置为 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> 时，在构建请求时将使用整个 URI（例如：
       <code class="literal">GET http://www.example.com/path/to/file.html HTTP/1.0</code>）。
       虽然这是一个非标准的请求格式，但某些代理服务器需要它。
      </p>
      <p class="para">
       默认值是 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </p>
     </dd>
    
    
     <dt id="context.http.follow-location">
      <code class="parameter">follow_location</code>
      <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
     </dt>
     <dd>
      <p class="para">
       跟随 <code class="literal">Location</code> header 的重定向。设置为 <code class="literal">0</code> 以禁用。
      </p>
      <p class="para">
       默认值是 <code class="literal">1</code>。
      </p>
     </dd>
    
    
     <dt id="context.http.max-redirects">
      <code class="parameter">max_redirects</code>
      <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
     </dt>
     <dd>
      <p class="para">
       跟随重定向的最大次数。值为 <code class="literal">1</code> 或更少则意味不跟随重定向。
      </p>
      <p class="para">
       默认值是 <code class="literal">20</code>。
      </p>
     </dd>
    
    
     <dt id="context.http.protocol-version">
      <code class="parameter">protocol_version</code>
      <span class="type"><a href="language.types.float.php" class="type float">float</a></span>
     </dt>
     <dd>
      <p class="para">
       HTTP 协议版本。
      </p>
      <p class="para">
       PHP 8.0.0 起默认值是 <code class="literal">1.1</code>。在此之前默认值是 <code class="literal">1.0</code>。
      </p>
     </dd>
    
    
     <dt id="context.http.timeout">
      <code class="parameter">timeout</code>
      <span class="type"><a href="language.types.float.php" class="type float">float</a></span>
     </dt>
     <dd>
      <p class="para">
       读取超时时间，单位为秒（s），用 <span class="type"><a href="language.types.float.php" class="type float">float</a></span> 指定（例如：<code class="literal">10.5</code>）。
      </p>
      <p class="para">
       默认使用 <var class="filename">php.ini</var> 中设置的 <a href="filesystem.configuration.php#ini.default-socket-timeout" class="link">default_socket_timeout</a>。
      </p>
     </dd>
    
    
     <dt id="context.http.ignore-errors">
      <code class="parameter">ignore_errors</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       即使是故障状态码依然获取内容。
      </p>
      <p class="para">
       默认值为 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-context.http-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="context.http.example-post">
    <p><strong>示例 #1 获取一个页面并发送 POST 数据</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$postdata </span><span style="color: #007700">= </span><span style="color: #0000BB">http_build_query</span><span style="color: #007700">(<br />    [<br />        </span><span style="color: #DD0000">'var1' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'some content'</span><span style="color: #007700">,<br />        </span><span style="color: #DD0000">'var2' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'doh'</span><span style="color: #007700">,<br />    ]<br />);<br /><br /></span><span style="color: #0000BB">$opts </span><span style="color: #007700">= [<br />    </span><span style="color: #DD0000">'http' </span><span style="color: #007700">=&gt; [<br />        </span><span style="color: #DD0000">'method'  </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'POST'</span><span style="color: #007700">,<br />        </span><span style="color: #DD0000">'header'  </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'Content-type: application/x-www-form-urlencoded'</span><span style="color: #007700">,<br />        </span><span style="color: #DD0000">'content' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">$postdata</span><span style="color: #007700">,<br />    ]<br />];<br /><br /></span><span style="color: #0000BB">$context </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_context_create</span><span style="color: #007700">(</span><span style="color: #0000BB">$opts</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://example.com/submit.php'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">$context</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="context.http.example-fetch-ignore-redirect">
    <p><strong>示例 #2 忽略重定向并获取 header 和内容</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$url </span><span style="color: #007700">= </span><span style="color: #DD0000">"http://www.example.org/header.php"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$opts </span><span style="color: #007700">= [<br />    </span><span style="color: #DD0000">'http' </span><span style="color: #007700">=&gt; [<br />        </span><span style="color: #DD0000">'method'        </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'GET'</span><span style="color: #007700">,<br />        </span><span style="color: #DD0000">'max_redirects' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'0'</span><span style="color: #007700">,<br />        </span><span style="color: #DD0000">'ignore_errors' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'1'</span><span style="color: #007700">,<br />    ]<br />];<br /><br /></span><span style="color: #0000BB">$context </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_context_create</span><span style="color: #007700">(</span><span style="color: #0000BB">$opts</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stream </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$url</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">$context</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// header 信息和 stream 的元数据一样<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">stream_get_meta_data</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// $url 的实际数据<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">stream_get_contents</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-context.http-notes">
  <h3 class="title">注释</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <strong>底层 socket stream 上下文选项</strong><br />
   <span class="simpara">
    <a href="transports.inet.php" class="link">底层传输</a>可能支持额外的上下文选项。对于
    <code class="literal">http://</code> 流，请参阅
    <code class="literal">tcp://</code> 传输的上下文选项。对于
    <code class="literal">https://</code> 流，请参阅
    <code class="literal">ssl://</code> 传输的上下文选项。
   </span>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <strong>HTTP 状态行</strong><br />
   <span class="simpara">
    当此流包装器跟随重定向时，<span class="function"><a href="function.stream-get-meta-data.php" class="function">stream_get_meta_data()</a></span> 返回的
    <code class="literal">wrapper_data</code> 中索引 <code class="literal">0</code>
    处不一定包含实际适用于内容数据的 HTTP 状态行。
   </span>
   <div class="example-contents screen">
<div class="notescode"><pre class="notescode">array (
  &#039;wrapper_data&#039; =&gt;
  array (
    0 =&gt; &#039;HTTP/1.0 301 Moved Permanently&#039;,
    1 =&gt; &#039;Cache-Control: no-cache&#039;,
    2 =&gt; &#039;Connection: close&#039;,
    3 =&gt; &#039;Location: http://example.com/foo.jpg&#039;,
    4 =&gt; &#039;HTTP/1.1 200 OK&#039;,
    ...</pre>
</div>
   </div>
   <span class="simpara">
    第一个请求返回 <code class="literal">301</code> （永久重定向），
    因此 stream 包装器自动跟随重定向到获得 <code class="literal">200</code> 
    响应（index = <code class="literal">4</code>）。
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-context.http-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><a href="wrappers.http.php" class="xref">http://</a></li>
    <li><a href="context.socket.php" class="xref">套接字上下文选项</a></li>
    <li><a href="context.ssl.php" class="xref">SSL 上下文选项</a></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>