1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 15:12:22 +01:00
Files
Yoshinari Takaoka c4cde2dfe0 Generate sapi methodsynopses based on stubs
Closes GH-285.


git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@352194 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-26 21:12:30 +00:00

122 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$-->
<!-- EN-Revision: a331ac8a86bb5929b79be9a369fac1e3af516241 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,takagi -->
<refentry xml:id="function.virtual" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>virtual</refname>
<refpurpose>Apache サブリクエストを実行する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>virtual</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
<para>
<function>virtual</function> は、<literal>mod_include</literal>
<literal>&lt;!--#include virtual...--&gt;</literal> と似ている
Apache 用関数です。
この関数は、Apache サブリクエストを実行します。
CGI スクリプトまたは <filename>.shtml</filename> ファイル、Apache を通して解釈を行う
他のものがある場合にこの関数は有用です。
CGI スクリプトの場合、そのスクリプトは、有効な CGI ヘッダを生成する
必要があることに注意してください。
最低でも、<literal>Content-Type</literal> ヘッダを生成する必要があります。
</para>
<para>
サブリクエストを実行するには、全てのバッファを終了、ブラウザへフラッシュし、
待機状態のヘッダも送信しておきます。
</para>
&apache.req.module;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
virtual コマンドが実行されるファイル
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
成功時は virtual コマンドの実行、失敗時は &false; を返します。
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<function>apache_note</function> の例を参照ください。
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
クエリ文字列をインクルードされるファイルに渡す事ができますが、
<varname>$_GET</varname> は親スクリプトからコピーされ、
<varname>$_SERVER['QUERY_STRING']</varname> は渡されたクエリ文字列に
なります。クエリ文字列は、Apache 2 を使用している場合の見渡されます。
要求されたファイルは Apache アクセスログに出力されません。
</para>
</warning>
<note>
<para>
要求されたファイルの中で設定された環境変数は、呼び出し元の
スクリプトからは見えません。
</para>
</note>
<note>
<para>
この関数を PHP ファイルに対して使ってもかまいません。
しかし、一般的に、PHP ファイルに対しては
<function>include</function> あるいは <function>require</function>
を使うほうがいいでしょう。
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>apache_note</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
-->