<?xml version="1.0" encoding="utf-8"?>

<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>Opciones de contexto HTTP</refname>

<refpurpose>Lista de opciones de contexto HTTP</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<para>

Opciones de contexto para los protocolos <literal>http://</literal>

y <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>, o

cualquier otro método HTTP soportado por el servidor remoto.

</para>

<para>

Por omisión, vale <constant>GET</constant>.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.header">

<term>

<parameter>header</parameter>

<type>array</type> o <type>string</type>

</term>

<listitem>

<para>

Encabezados adicionales a enviar durante la petición.

Los valores de esta opción sobrescribirán otros valores

(como <literal>User-agent:</literal>, <literal>Host:</literal>,

y <literal>Authentication:</literal>),

incluso al seguir redirecciones <literal>Location:</literal>.

Por lo tanto, no se recomienda definir el encabezado

<literal>Host:</literal>, si <parameter>follow_location</parameter>

está activado.

</para>

<para>

Una cadena debe contener pares <literal>Clave : valor</literal>

delimitados por <literal>\r\n</literal>, por ejemplo :

<literal>"Content-Type: application/json\r\nConnection: close"</literal>.

Un array debe contener una lista de pares <literal>Clave : valor</literal>, por ejemplo :

<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 enviar con el encabezado <literal>User-Agent:</literal>. Este valor

solo debe ser utilizado si el agente de usuario no está

especificado en la opción de contexto <literal>header</literal> anterior.

</para>

<para>

Por omisión, se utilizará el valor de la opción de configuración

<link linkend="ini.user-agent">user_agent</link> del archivo

&php.ini;.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.content">

<term>

<parameter>content</parameter>

<type>&string;</type>

</term>

<listitem>

<para>

Los datos adicionales a enviar después de los encabezados. Típicamente utilizados

durante las peticiones POST o PUT.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.proxy">

<term>

<parameter>proxy</parameter>

<type>&string;</type>

</term>

<listitem>

<para>

URI de la dirección del proxy (ej.

<literal>tcp://proxy.example.com:5100</literal>).

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.request-fulluri">

<term>

<parameter>request_fulluri</parameter>

<type>&boolean;</type>

</term>

<listitem>

<para>

Cuando se define como &true;, la URI completa será utilizada al

construir la petición (ej.

<literal>GET http://www.example.com/path/to/file.html HTTP/1.0</literal>).

Aunque este formato de petición no es estándar, algunos servidores de

proxy lo requieren.

</para>

<para>

Por omisión, vale &false;.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.follow-location">

<term>

<parameter>follow_location</parameter>

<type>int</type>

</term>

<listitem>

<para>

Sigue las redirecciones <literal>Location</literal>.

Debe definirse como <literal>0</literal> para desactivar.

</para>

<para>

Por omisión, vale <literal>1</literal>.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.max-redirects">

<term>

<parameter>max_redirects</parameter>

<type>int</type>

</term>

<listitem>

<para>

El número máximo de redirecciones a seguir. El valor <literal>1</literal>

o inferior significa que ninguna redirección será seguida.

</para>

<para>

Por omisión, vale <literal>20</literal>.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.protocol-version">

<term>

<parameter>protocol_version</parameter>

<type>&float;</type>

</term>

<listitem>

<para>

Versión del protocolo HTTP.

</para>

<para>

Por omisión, vale <literal>1.1</literal> a partir de PHP 8.0.0; antes

de esta versión el valor por omisión era <literal>1.0</literal>.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.timeout">

<term>

<parameter>timeout</parameter>

<type>&float;</type>

</term>

<listitem>

<para>

Tiempo máximo de espera para la lectura, en forma de &float;

(ej. <literal>10.5</literal>).

</para>

<para>

Por omisión, se utilizará el valor de la opción de configuración

<link linkend="ini.default-socket-timeout">default_socket_timeout</link>

del archivo &php.ini;.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="context.http.ignore-errors">

<term>

<parameter>ignore_errors</parameter>

<type>&boolean;</type>

</term>

<listitem>

<para>

Obtiene el contenido incluso al recibir un código de error.

</para>

<para>

Por omisión, vale &false;.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1><!-- }}} -->

<refsect1 role="examples"><!-- {{{ -->

&reftitle.examples;

<para>

<example xml:id="context.http.example-post"><!-- {{{ -->

<title>Obtención de una página y envío de datos POST</title>

<programlisting role="php">

</programlisting>

</example><!-- }}} -->

</para>

<para>

<example xml:id="context.http.example-fetch-ignore-redirect"><!-- {{{ -->

<title>Ignora las redirecciones pero obtiene los encabezados y el contenido</title>

<programlisting role="php">

</programlisting>

</example><!-- }}} -->

</para>

</refsect1><!-- }}} -->

<refsect1 role="notes">

&reftitle.notes;

<note>

<title>Opciones de contexto del flujo subyacente</title>

<simpara>

Opciones de contexto adicionales pueden ser

soportadas por el

<link linkend="transports.inet">transporte subyacente</link>.

Para los flujos <literal>http://</literal>, consulte las

opciones de contexto del transporte <literal>tcp://</literal>.

Para los flujos <literal>https://</literal>, consulte las

opciones de contexto del transporte <literal>ssl://</literal>.

</simpara>

</note>

<note>

<title>Línea de estado HTTP</title>

<simpara>

Cuando este manejador de flujo sigue una redirección,

<literal>wrapper_data</literal>, devuelto por la función

<function>stream_get_meta_data</function> no debe contener

necesariamente la línea de estado HTTP que se aplica a los

datos de contenido en el índice <literal>0</literal>.

</simpara>

<screen>

</screen>

<simpara>

La primera petición devuelve una <literal>301</literal>

(redirección permanente), por lo tanto, el manejador de flujo

sigue automáticamente la redirección para obtener una respuesta

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