archived-doc-ru/language/context/http.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3abd17e61d5022d503604cc06894254e3281acf5 Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<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-контекста</refname>
  <refpurpose>Список опций HTTP-контекста</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   Опции контекста для транспортных протоколов <literal>http://</literal>
   и <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>
       или любой другой HTTP-метод, который поддерживает удалённый сервер.
      </para>
      <para>
       По умолчанию — <constant>GET</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.header">
     <term>
      <parameter>header</parameter>
      <type>array</type> или <type>string</type>
     </term>
     <listitem>
      <para>
       Дополнительные заголовки для отправки в запросе. Значения
       в этой опции переопределяют другие значения наподобие
       <literal>User-Agent:</literal>, <literal>Host:</literal>
       и <literal>Authentication:</literal>, даже
       при следовании перенаправлениям заголовка <literal>Location:</literal>.
       Поэтому лучше не устанавливать заголовок <literal>Host:</literal>,
       если включили опцию <parameter>follow_location</parameter>.
      </para>
      <para>
       Строковые значения указывают как пары <literal>Ключ: значение</literal> и разделяют последовательностью символов
       <literal>\r\n</literal>, например:
       <literal>"Content-Type: application/json\r\nConnection: close"</literal>.
       В массиве значения указывают как список пар <literal>Ключ: значение</literal>, например:
       <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>
       Значение для отправки в заголовке <literal>User-Agent:</literal>. Значение
       учитывается, только если заголовок User-Agent <emphasis>не</emphasis> указали
       в опции контекста <literal>header</literal> выше.
      </para>
      <para>
       По умолчанию извлекается значение директивы
       <link linkend="ini.user-agent">user_agent</link>
       из файла &php.ini;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.content">
     <term>
      <parameter>content</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Дополнительные данные для отправки после
       заголовков. Параметр часто указывают
       с POST- и PUT-запросами.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.proxy">
     <term>
      <parameter>proxy</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       URI-идентификатор, который указывает адрес прокси-сервера, например:
       <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>
       Со значением &true; при формировании запроса
       запрашивается весь URI,
       например: <literal>GET
       http://www.example.com/path/to/file.html
       HTTP/1.0</literal>.
       Некоторые прокси-серверы требуют указывать весь идентификатор,
       хотя это нестандартный формат запроса.
      </para>
      <para>
       По умолчанию &false;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.follow-location">
     <term>
      <parameter>follow_location</parameter>
      <type>int</type>
     </term>
     <listitem>
      <para>
       Опция указывает, следовать ли перенаправлениям заголовка
       <literal>Location</literal>.
       Чтобы отключить, устанавливают значение
       <literal>0</literal>.
      </para>
      <para>
       По умолчанию — <literal>1</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.max-redirects">
     <term>
      <parameter>max_redirects</parameter>
      <type>int</type>
     </term>
     <listitem>
      <para>
       Максимальное количество перенаправлений,
       которым можно следовать. Значение
       <literal>1</literal> или
       меньше означает, что перенаправления не выполняются.
      </para>
      <para>
       По умолчанию <literal>20</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.protocol-version">
     <term>
      <parameter>protocol_version</parameter>
      <type>float</type>
     </term>
     <listitem>
      <para>
       Версия HTTP-протокола.
      </para>
      <para>
       С PHP 8.0.0 значение по умолчанию — <literal>1.1</literal>;
       до этой версии значение по умолчанию равнялось <literal>1.0</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.timeout">
     <term>
      <parameter>timeout</parameter>
      <type>float</type>
     </term>
     <listitem>
      <para>
       Время ожидания на чтение в секундах
       в виде числа с плавающей точкой (<type>float</type>),
       например: <literal>10.5</literal>.
      </para>
      <para>
       По умолчанию извлекается значение директивы
       <link linkend="ini.default-socket-timeout">default_socket_timeout</link>
       из файла &php.ini;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.http.ignore-errors">
     <term>
      <parameter>ignore_errors</parameter>
      <type>bool</type>
     </term>
     <listitem>
      <para>
       Опция указывает, извлекать ли содержимое даже при неуспешных
       статусах завершения.
      </para>
      <para>
       По умолчанию — &false;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="context.http.example-post"><!-- {{{ -->
    <title>Пример получения страницы и отправки данных методом POST</title>
    <programlisting role="php">
<![CDATA[
<?php

$postdata = http_build_query(
    [
        'var1' => 'некоторое содержимое',
        '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>Пример игнорирования перенаправлений, но с получением заголовков и контента</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);

// Информация о заголовках
// и метаданные о потоке
var_dump(stream_get_meta_data($stream));

// Фактические данные в переменной $url
var_dump(stream_get_contents($stream));
fclose($stream);

?>
]]>
    </programlisting>
   </example><!-- }}} -->
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <title>Опции контекста потока нижележащего сокета</title>
   <simpara>
    <link linkend="transports.inet">Нижележащий транспортный протокол</link>
    может поддерживать дополнительные опции контекста.
    Для потоков <literal>http://</literal> смотрите описание
    опций контекста для транспортного протокола <literal>tcp://</literal>.
    Для потоков <literal>https://</literal> смотрите описание
    опций контекста для транспортного протокола <literal>ssl://</literal>.
   </simpara>
  </note>
  <note>
   <title>Строка HTTP-статуса</title>
   <simpara>
    Когда эта обёртка потока следует перенаправлениям,
    элемент <literal>wrapper_data</literal>, который возвращает
    функция <function>stream_get_meta_data</function>, необязательно содержит
    строку HTTP-статуса, которая на самом деле относится к содержанию данных
    в индексе <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>
    Первый запрос вернул код <literal>301</literal> (постоянное перенаправление),
    поэтому обёртка потока автоматически последовала перенаправлению, чтобы получить
    ответ с кодом <literal>200</literal> (индекс = <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
-->