archived-doc-pt-br/language/context/http.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3abd17e61d5022d503604cc06894254e3281acf5 Maintainer: leonardolara Status: ready --><!-- CREDITS: fabioluciano,lhsazevedo,leonardolara -->

<refentry xml:id="context.http" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" annotations="verify_info:false" role="stream_context_option">
 <refnamediv>
  <refname>Opções de contexto do HTTP</refname>
  <refpurpose>Lista de opções de contexto do HTTP</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   Opções de contexto dos transportadores <literal>http://</literal> e
   <literal>https://</literal>.
  </para>
 </refsect1>

 <refsect1 role="options"><!-- {{{ -->
  &reftitle.options;
  <para>
   <variablelist>
    <varlistentry xml:id="context.http.method">
     <term>
      <parameter>method</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       <constant>GET</constant>, <constant>POST</constant> ou
       qualquer outro método HTTP suportado pelo servidor remoto.
      </para>
      <para>
       <constant>GET</constant> é o padrão.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.header">
     <term>
      <parameter>header</parameter>
      <type>array</type> ou <type>string</type>
     </term>
     <listitem>
      <para>
       Cabeçalhos adicionais que devem ser enviados durante a requisição. Valores
       nesta opção sobrescrevem outros valores (como
       <literal>User-agent:</literal>, <literal>Host:</literal>,
       e <literal>Authentication:</literal>),
       mesmo ao seguir redirecionamentos <literal>Location:</literal>.
       Portanto, não é recomendado definir um cabeçalho <literal>Host:</literal>,
       se <parameter>follow_location</parameter> estiver habilitado.
      </para>
      <para>
       Os valores em string devem ser pares de <literal>Chave: valor</literal> delimitados por
       <literal>\r\n</literal>, por exemplo,.
       <literal>"Content-Type: application/json\r\nConnection: close"</literal>.
       Os valores em array devem ser uma lista de pares de <literal>Chave: valor</literal>, por exemplo,
       <literal>["Content-Type: application/json", "Connection: close"]</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.user-agent">
     <term>
      <parameter>user_agent</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Valor a ser enviado no cabeçalho  <literal>User-Agent:</literal>. Este valor só
       é utilizado se o user-agent <emphasis>não</emphasis> for especificado
       na opção de contexto <literal>header</literal> acima.
      </para>
      <para>
       Por padrão, a configuração
       <link linkend="ini.user-agent">user_agent</link>
       do &php.ini; é utilizada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.content">
     <term>
      <parameter>content</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Dados adicionais a serem enviados depois dos cabeçalhos. Tipicamente utilizado
       em requisições POST ou PUT.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.proxy">
     <term>
      <parameter>proxy</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       URI que especifica o endereço do servidor de proxy (ex.:
       <literal>tcp://proxy.example.com:5100</literal>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.request-fulluri">
     <term>
      <parameter>request_fulluri</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Quando definido como &true;, todo o URI será utilizado na
       construção da requisição (ex.:
       <literal>GET http://www.example.com/path/to/file.html HTTP/1.0</literal>).
       Mesmo não sendo um formato padronizado de requisição, alguns
       servidores de proxy o exigem.
      </para>
      <para>
       &false; é o padrão.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.follow-location">
     <term>
      <parameter>follow_location</parameter>
      <type>int</type>
     </term>
     <listitem>
      <para>
       Segue os redirecionamentos feitos com o cabeçalho <literal>Location</literal>.
       Defina com <literal>0</literal> para desabilitar.
      </para>
      <para>
       <literal>1</literal> é o padrão.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.max-redirects">
     <term>
      <parameter>max_redirects</parameter>
      <type>int</type>
     </term>
     <listitem>
      <para>
       O número máximo de redirecionamentos a serem feitos. O valor <literal>1</literal> ou
       inferior significam que os redirecionamentos não serão feitos.
      </para>
      <para>
       <literal>20</literal> é o padrão.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.protocol-version">
     <term>
      <parameter>protocol_version</parameter>
      <type>float</type>
     </term>
     <listitem>
      <para>
       Versão do protocolo HTTP.
      </para>
      <para>
       O padrão é <literal>1.1</literal> a partir do PHP 8.0.0;
       antes dessa versão o padrão era <literal>1.0</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.timeout">
     <term>
      <parameter>timeout</parameter>
      <type>float</type>
     </term>
     <listitem>
      <para>
       Limite de tempo de leitura em segundos, especificado com um <type>float</type>
       (por exemplo, <literal>10.5</literal>).
      </para>
      <para>
       Por padrão, a configuração
       <link linkend="ini.default-socket-timeout">default_socket_timeout</link>
       do &php.ini; é utilizada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.ignore-errors">
     <term>
      <parameter>ignore_errors</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Retorna o conteúdo mesmo que códigos de status de falha sejam retornados.
      </para>
      <para>
       &false;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="context.http.example-post"><!-- {{{ -->
    <title>Buscando uma página e enviando dados pelo método POST</title>
    <programlisting role="php">
<![CDATA[
<?php

$postdata = http_build_query(
    [
        'var1' => 'some content',
        'var2' => 'doh'
    ]
);

$opts = [
    'http' => [
        'method'  => 'POST',
        'header'  => 'Content-type: application/x-www-form-urlencoded',
        'content' => $postdata
    ]
];

$context = stream_context_create($opts);

$result = file_get_contents('http://example.com/submit.php', false, $context);

?>
]]>
    </programlisting>
   </example><!-- }}} -->
  </para>
  <para>
   <example xml:id="context.http.example-fetch-ignore-redirect"><!-- {{{ -->
    <title>Ignorando redirecionamentos mas trazendo os cabeçalhos e conteúdo</title>
    <programlisting role="php">
<![CDATA[
<?php

$url = "http://www.example.org/header.php";

$opts = [
    'http' => [
        'method' => 'GET',
        'max_redirects' => '0',
        'ignore_errors' => '1'
    ]
];

$context = stream_context_create($opts);
$stream = fopen($url, 'r', false, $context);

// informação de cabeçalho e metadados
// sobre o fluxo
var_dump(stream_get_meta_data($stream));

// dados reais no $url
var_dump(stream_get_contents($stream));
fclose($stream);
?>
]]>
    </programlisting>
   </example><!-- }}} -->
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Opções de contextos de soquetes de fluxo básicos</title>
   <simpara>
    Opções de contextos adicionais podem ser suportadas em
    <link linkend="transports.inet">transportes básicos</link>
    Em fluxos <literal>http://</literal>, use
    as opções de contexto do transporte <literal>tcp://</literal>. Em fluxos
    <literal>https://</literal>, use as opções de contexto do
    transporte <literal>ssl://</literal>.
   </simpara>
  </note>
  <note>
   <title>Linha de status HTTP</title>
   <simpara>
    Quando este empacotador de fluxo faz um redirecionamento, o
    <literal>wrapper_data</literal> retornado pela função
    <function>stream_get_meta_data</function> pode não conter necessariamente
    a linha de status HTTP, que atualmente se aplica ao conteúdo no índice
    <literal>0</literal>.
   </simpara>
   <screen>
<![CDATA[
array (
  'wrapper_data' =>
  array (
    0 => 'HTTP/1.0 301 Moved Permanently',
    1 => 'Cache-Control: no-cache',
    2 => 'Connection: close',
    3 => 'Location: http://example.com/foo.jpg',
    4 => 'HTTP/1.1 200 OK',
    ...
]]>
   </screen>
   <simpara>
    A primeira requisição retornou <literal>301</literal> (redirecionamento permanente),
    com isso o empacotador de fluxo fará o redirecionamento automaticamente para conseguir
    uma resposta <literal>200</literal> (índice = <literal>4</literal>).
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="wrappers.http" /></member>
    <member><xref linkend="context.socket" /></member>
    <member><xref linkend="context.ssl" /></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
-->