mirror of
https://github.com/php/doc-zh.git
synced 2026-03-24 15:12:20 +01:00
171 lines
4.1 KiB
XML
171 lines
4.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: a331ac8a86bb5929b79be9a369fac1e3af516241 Maintainer: HonestQiao Status: ready -->
|
|
<!-- Reviewed: no Maintainer: HonestQiao -->
|
|
<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>apache_note</refname>
|
|
<refpurpose>取得或设置 apache 请求记录</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>apache_note</methodname>
|
|
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>note_value</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
这个函数是 Apache <literal>table_get</literal> 和
|
|
<literal>table_set</literal> 的包装。
|
|
它编辑了请求中存在的 notes 表。
|
|
这个表的目的是允许 Apache 模块进行通讯。
|
|
</para>
|
|
<para>
|
|
<function>apache_note</function> 的主要用途是在同一个请求中，从一个模块传递信息到另一个模块。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>note_name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
note 名。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>note_value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
note 值。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
如果 <parameter>note_value</parameter> 被省略或者为 &null;，则返回记录
|
|
<literal>note_name</literal> 的当前值。否则将记录
|
|
<literal>note_name</literal> 的值设为
|
|
<literal>note_value</literal> 并返回记录
|
|
<literal>note_name</literal> 的前一个值。如果未能获取记录，则返回 &false;。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
现在 <parameter>note_value</parameter> 可为 null。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>在 PHP 与 Perl 之间传递信息</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
apache_note('name', 'Fredrik Ekengren');
|
|
|
|
// 调用 perl 脚本
|
|
virtual("/perl/some_script.pl");
|
|
|
|
$result = apache_note("resultdata");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<programlisting role="perl">
|
|
<![CDATA[
|
|
# 获取 Apache 请求对象
|
|
my $r = Apache->request()->main();
|
|
|
|
# 获取传递的数据
|
|
my $name = $r->notes('name');
|
|
|
|
# 一些处理
|
|
|
|
# 将结果返回给 PHP
|
|
$r->notes('resultdata', $result);
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>在 access.log 中记录值</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
apache_note('sessionID', session_id());
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<programlisting role="apache">
|
|
<![CDATA[
|
|
# "%{sessionID}n" can be used in the LogFormat directive
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>virtual</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
|
|
-->
|