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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>apache_note</refname>
<refpurpose>Get and set apache request notes</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>
This function is a wrapper for Apache's <literal>table_get</literal> and
<literal>table_set</literal>. It edits the table of notes that exists
during a request. The table's purpose is to allow Apache modules to
communicate.
</para>
<para>
The main use for <function>apache_note</function> is to pass information
from one module to another within the same request.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>note_name</parameter></term>
<listitem>
<para>
The name of the note.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>note_value</parameter></term>
<listitem>
<para>
The value of the note.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If <parameter>note_value</parameter> is omitted or &null;, it returns the current value of note
<literal>note_name</literal>. Otherwise, it
sets the value of note <literal>note_name</literal> to
<literal>note_value</literal> and returns the previous value of
note <literal>note_name</literal>.
If the note cannot be retrieved, &false; is returned.
</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> is nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Passing information between PHP and Perl</title>
<programlisting role="php">
<![CDATA[
<?php
apache_note('name', 'Fredrik Ekengren');
// Call perl script
virtual("/perl/some_script.pl");
$result = apache_note("resultdata");
?>
]]>
</programlisting>
<programlisting role="perl">
<![CDATA[
# Get Apache request object
my $r = Apache->request()->main();
# Get passed data
my $name = $r->notes('name');
# some processing
# Pass result back to PHP
$r->notes('resultdata', $result);
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Logging values in 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
-->
|
