-
Notifications
You must be signed in to change notification settings - Fork 82
Expand file tree
/
Copy pathhttp-response-code.xml
More file actions
139 lines (127 loc) · 4.05 KB
/
http-response-code.xml
File metadata and controls
139 lines (127 loc) · 4.05 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: satoruyoshida Status: ready -->
<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>
<parameter>response_code</parameter> が省略されており、
かつ Web サーバー環境以外 (CLI アプリケーションなど) で実行した場合には、&false; を返します。
<parameter>response_code</parameter> を指定して、
かつ Web サーバー環境以外 (CLI アプリケーションなど) で実行した場合
(ただし、事前にレスポンスのステータスが設定されていない場合に限る) には、&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
-->