mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
0c9ff443e0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338620 c90b9560-bf6c-de11-be94-00142212c4b1
142 lines
3.4 KiB
XML
142 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Get or Set the HTTP response code</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>
|
|
Gets or sets the HTTP response status code.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>response_code</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The optional <parameter>response_code</parameter> will set the response code.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
If <parameter>response_code</parameter> is provided, then the previous
|
|
status code will be returned. If <parameter>response_code</parameter> is not
|
|
provided, then the current status code will be returned. Both of these
|
|
values will default to a <literal>200</literal> status code if used in a web
|
|
server environment.
|
|
</para>
|
|
<para>
|
|
&false; will be returned if <parameter>response_code</parameter> is not
|
|
provided and it is not invoked in a web server environment (such as from a
|
|
CLI application). &true; will be returned if
|
|
<parameter>response_code</parameter> is provided and it is not invoked in a
|
|
web server environment (but only when no previous response status has been
|
|
set).
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Using <function>http_response_code</function> in a web server environment</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// Get the current response code and set a new one
|
|
var_dump(http_response_code(404));
|
|
|
|
// Get the new response code
|
|
var_dump(http_response_code());
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
int(200)
|
|
int(404)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>Using <function>http_response_code</function> in a CLI environment</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// Get the current default response code
|
|
var_dump(http_response_code());
|
|
|
|
// Set a response code
|
|
var_dump(http_response_code(201));
|
|
|
|
// Get the new response code
|
|
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
|
|
-->
|