http-response-code.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.http-response-code" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>http_response_code</refname>
  <refpurpose>Получает или устанавливает код ответа HTTP</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>bool</type></type><methodname>http_response_code</methodname>
   <methodparam choice="opt"><type>int</type><parameter>response_code</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
  Получает или задаёт коды ответов HTTP.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>response_code</parameter></term>
     <listitem>
      <para>
       Код ответа устанавливается с помощью опционального параметра <parameter>response_code</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Если <parameter>response_code</parameter> задан, то будет возвращён предыдущий код
   статуса. Если <parameter>response_code</parameter> не задан, то будет возвращён
   текущий код статуса. Оба этих значения будут по умолчанию иметь код состояния <literal>200</literal>,
   если они используются в окружении веб-сервера.
  </para>
  <para>
   Если <parameter>response_code</parameter> не задан и используется не в окружении
   веб-сервера (например, в CLI), то будет возвращено &false;. Если
   <parameter>response_code</parameter> задан и используется не в окружении
   веб-сервера, то будет возвращено &true; (но только если не был установлен предыдущий
   код статуса).
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Использование <function>http_response_code</function> в окружении веб-сервера</title>
    <programlisting role="php">
<![CDATA[
<?php

// Берём текущий код и устанавливаем новый
var_dump(http_response_code(404));

// Берём новый код
var_dump(http_response_code());
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(200)
int(404)
]]>
    </screen>
   </example>
   <example>
    <title>Использование <function>http_response_code</function> в CLI</title>
    <programlisting role="php">
<![CDATA[
<?php

// Берём текущий код по умолчанию
var_dump(http_response_code());

// Устанавливаем код
var_dump(http_response_code(201));

// Берём новый код
var_dump(http_response_code());
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
bool(false)
bool(true)
int(201)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>header</function></member>
    <member><function>headers_list</function></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
-->