http-response-code.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9ff443e0eb04ca23595678d9cd44e20e5f6fdd Maintainer: seros 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>Obtener o establecer el código de respuesta HTTP</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>http_response_code</methodname>
   <methodparam choice="opt"><type>int</type><parameter>response_code</parameter></methodparam>
  </methodsynopsis>
  <para>
   Obtener o establecer el código de estado de la respuesta HTTP.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>response_code</parameter></term>
     <listitem>
      <para>
       El parámetro opcional <parameter>response_code</parameter> establecerá el código de respuesta.
      </para>
     </listitem>
    </varlistentry>   
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si se proporciona <parameter>response_code</parameter>, se devolverá el
   código de estado anterior. Si no se proporciona <parameter>response_code</parameter>,
   se devolverá el código de estado actual. El valor predeterminado de estos
   dos valores será un código de estado <literal>200</literal> si se emplea en
   un entorno de servidor web.
  </para>
  <para>
   Se devolverá &false; si <parameter>response_code</parameter> no se
   proporciona y no se invoca en un entorno de servidor web (como por ejemplo desde una
   aplicación CLI). Se devolverá &true; si se proporciona
   <parameter>response_code</parameter> y no se invoca en un
   entorno de servidor web (aunque solamente cuando no haya sido establecido
   ningún estado de respuesta anterior).
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Empleo de <function>http_response_code</function> en un entorno de servidor web</title>
    <programlisting role="php">
<![CDATA[
<?php

// Obtener el código de la respuesta actual y establecer uno nuevo
var_dump(http_response_code(404));

// Obtener el nuevo código de respuesta
var_dump(http_response_code());
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(200)
int(404)
]]>
    </screen>
   </example>
   <example>
    <title>Empleo de <function>http_response_code</function> en un entorno CLI</title>
    <programlisting role="php">
<![CDATA[
<?php

// Obtener el código de respuesta predeterminado actual
var_dump(http_response_code());

// Establece un código de respuesta
var_dump(http_response_code(201));

// Obtener el nuevo cógido de respuesta
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
-->