1
0
mirror of https://github.com/php/doc-zh.git synced 2026-03-24 15:12:20 +01:00
Files
archived-doc-zh/reference/network/functions/http-response-code.xml
魔王卷子 ca53560a64 Update network (#418)
* Update headers-sent.xml

* Update gethostbyaddr.xml

* Update setcookie.xml

* Update gethostname.xml

* Update getservbyname.xml

* Update closelog.xml

* Update long2ip.xml

* Update http-response-code.xml

* Update gethostbyaddr.xml
2022-10-18 22:21:51 +08:00

139 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<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>,会返回当前的状态码。
在 Web 服务器环境里,这些状态码的默认值都是 <literal>200</literal>
</para>
<para>
如果在非 Web 服务器环境里调用(比如 CLI 应用里),
不提供 <parameter>response_code</parameter> 就会返回 &false;
在非 Web 服务器环境里,提供 <parameter>response_code</parameter> 会返回 &true;
(仅仅在先前没有设置过状态码的时候)。
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Web 服务器环境内使用 <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>在 CLI 环境内使用 <function>http_response_code</function></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
-->