http-response-code.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: girgias Status: ready -->
<!-- Reviewed: yes -->
<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>Récupère ou définit le code de réponse 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>
   Récupère ou définit le code d'état de réponse HTTP.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>response_code</parameter></term>
     <listitem>
      <para>
       Le paramètre optionnel <parameter>response_code</parameter> définira le code de réponse.
      </para>
     </listitem>
    </varlistentry>   
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si <parameter>response_code</parameter> est fournit, dans ce cas là le code d'état
   précédent sera retourné. Si <parameter>response_code</parameter> n'est pas fournit,
   alors le code d'état actuel sera retourné. Ces deux valeurs seront par défaut le
   code d'état <literal>200</literal> si utilisé dans un environnement de serveur Web.
  </para>
  <para>
   &false; sera retourné si <parameter>response_code</parameter> n'est pas fournit
   et n'est pas invoqué dans un environnement de serveur Web (par exemple depuis
   une application CLI) &true; sera retourné si
   <parameter>response_code</parameter> est fournit et n'est pas invoqué dans un
   environnement de serveur Web (mais uniquement si aucun état de réponse précédent
   n'a été défini).
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Utiliser <function>http_response_code</function> dans un environnement de serveur Web</title>
    <programlisting role="php">
<![CDATA[
<?php

// Récupérer le code actuel de réponse et définir un nouveau
var_dump(http_response_code(404));

// Récupérer le nouveau code de réponse
var_dump(http_response_code());
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(200)
int(404)
]]>
    </screen>
   </example>
   <example>
    <title>Utiliser <function>http_response_code</function> dans un environnement CLI</title>
    <programlisting role="php">
<![CDATA[
<?php

// Récupérer le code de réponse par défaut
var_dump(http_response_code());

// Définir un code de réponse
http_response_code(404);

// Récupérer le nouveau code de réponse
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
-->