mirror of
https://github.com/php/doc-ja.git
synced 2026-03-25 15:42:08 +01:00
def02cf418
Cf. <https://github.com/php/doc-en/pull/289>. git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@352198 c90b9560-bf6c-de11-be94-00142212c4b1
140 lines
4.1 KiB
XML
140 lines
4.1 KiB
XML
<?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
|
|
-->
|