<?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>HTTP-Kontextoptionen</refname>

<refpurpose>Liste der HTTP-Kontextoptionen</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<para>

Kontextoptionen für die Transportprotokolle <literal>http://</literal> und

<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> oder eine andere

vom entfernten Server unterstützte HTTP-Methode.

</para>

<para>

Der Standardwert ist <constant>GET</constant>.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>header</parameter>

<type>array</type> oder <type>string</type>

</term>

<listitem>

<para>

Zusätzliche Kopfzeilen, die während der Anfrage gesendet werden. Die

Werte in dieser Option überschreiben andere Werte (wie

<literal>User-Agent:</literal>, <literal>Host:</literal>, und

<literal>Authentication:</literal>), selbst wenn sie

<literal>Location:</literal>-Weiterleitungen folgen. Es ist daher nicht

empfehlenswert, eine <literal>Host:</literal>-Kopfzeile zu setzen, wenn

<parameter>follow_location</parameter> aktiviert ist.

</para>

<para>

Der Wert der Zeichenkette sollte aus

<literal>Schlüssel: Wert</literal>-Paaren bestehen, die durch

<literal>\r\n</literal> begrenzt sind, &zb;

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

Der Wert des Arrays sollte eine Liste von

<literal>Schlüssel: Wert</literal>-Paaren sein, &zb;

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

Der Wert, der mit der Kopfzeile <literal>User-Agent:</literal> gesendet

wird. Dieser Wert wird nur verwendet, wenn der User-Agent

<emphasis>nicht</emphasis> in der obigen Kontextoption

<literal>header</literal> angegeben wurde.

</para>

<para>

Standardmäßig wird der Wert von

<link linkend="ini.user-agent">user_agent</link> aus der &php.ini;

verwendet.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>content</parameter>

<type>string</type>

</term>

<listitem>

<para>

Zusätzliche Daten, die nach den Kopfzeilen gesendet werden; wird in der

Regel bei POST- oder PUT-Anfragen verwendet.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>proxy</parameter>

<type>string</type>

</term>

<listitem>

<para>

Der URI, der die Adresse des Proxy-Servers angibt (&zb;

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

Wenn auf &true; gesetzt, wird beim Aufbau der Anfrage der gesamte URI

verwendet (&zb;

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

Dies ist zwar kein Standard-Anfrageformat, wird aber von einigen

Proxy-Servern verlangt.

</para>

<para>

Der Standardwert ist &false;.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>follow_location</parameter>

<type>int</type>

</term>

<listitem>

<para>

Folgt den Weiterleitungen der Kopfzeile <literal>Location</literal>;

zum Deaktivieren auf 0 setzen.

</para>

<para>

Der Standardwert ist <literal>1</literal>.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>max_redirects</parameter>

<type>int</type>

</term>

<listitem>

<para>

Die maximale Anzahl der zu verfolgenden Weiterleitungen. Der Wert

<literal>1</literal> oder weniger bedeutet, dass keine Weiterleitungen

verfolgt werden.

</para>

<para>

Der Standardwert ist <literal>20</literal>.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>protocol_version</parameter>

<type>float</type>

</term>

<listitem>

<para>

Die Version des HTTP-Protokolls.

</para>

<para>

Seit PHP 8.0.0 ist der Standardwert <literal>1.1</literal>; vorher war

es <literal>1.0</literal>.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>timeout</parameter>

<type>float</type>

</term>

<listitem>

<para>

Das Zeitlimit für Lesevorgänge in Sekunden, angegeben durch einen Wert

vom Typ <type>float</type> (&zb; <literal>10.5</literal>).

</para>

<para>

Standardmäßig wird der Wert von

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

aus der &php.ini; verwendet.

</para>

</listitem>

</varlistentry>

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

<term>

<parameter>ignore_errors</parameter>

<type>bool</type>

</term>

<listitem>

<para>

Ruft den Inhalt auch dann ab, wenn ein Fehlerstatus vorliegt.

</para>

<para>

Der Standardwert ist &false;.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

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

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

&reftitle.examples;

<para>

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

<title>Abrufen einer Seite mit Übermittlung von POST-Daten</title>

<programlisting role="php">

</programlisting>

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

</para>

<para>

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

<title>Weiterleitungen ignorieren, aber Kopfzeilen und Inhalt abrufen</title>

<programlisting role="php">

</programlisting>

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

</para>

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

<refsect1 role="notes">

&reftitle.notes;

<note>

<title>Kontextoptionen für den zugrundeliegenden Socket-Stream</title>

<simpara>

Vom <link linkend="transports.inet">zugrundeliegenden Transport</link>

können zusätzliche Kontextoptionen unterstützt werden. Für

<literal>http://</literal>-Streams, siehe Kontextoptionen für das

Transportprotokoll <literal>tcp://</literal>. Für

<literal>https://</literal>-Streams, siehe Kontextoptionen für das

Transportprotokoll <literal>ssl://</literal>.

</simpara>

</note>

<note>

<title>HTTP-Statuszeile</title>

<simpara>

Wenn dieser Stream-Wrapper einer Weiterleitung (Redirect) folgt, ist der

Inhalt von Index <literal>0</literal> in den von

<function>stream_get_meta_data</function> zurückgegebenen

<literal>wrapper_data</literal> nicht unbedingt die HTTP-Statuszeile für

diesen Inhalt.

</simpara>

<screen>

</screen>

<simpara>

Die erste Anfrage lieferte eine <literal>301</literal> (permanente

Weiterleitung), sodass der Stream-Wrapper automatisch der Weiterleitung

folgte, bei der er eine <literal>200</literal>-Antwort erhielt

(index = <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>