-
Notifications
You must be signed in to change notification settings - Fork 80
Expand file tree
/
Copy pathapache-note.xml
More file actions
171 lines (156 loc) · 5 KB
/
apache-note.xml
File metadata and controls
171 lines (156 loc) · 5 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
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
171
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: a331ac8a86bb5929b79be9a369fac1e3af516241 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<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>
Эта функция является обёрткой для <literal>table_get</literal> и
<literal>table_set</literal>. С её помощью можно редактировать таблицу уведомлений
(apache notes table), которая создаётся во время передачи запроса.
Таблица уведомлений позволяет модулям 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>
Название уведомления.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>note_value</parameter></term>
<listitem>
<para>
Значение уведомления.
</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" может быть использован в директиве LogFormat
]]>
</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
-->