-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathapache-note.xml
More file actions
170 lines (156 loc) · 4.28 KB
/
apache-note.xml
File metadata and controls
170 lines (156 loc) · 4.28 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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a331ac8a86bb5929b79be9a369fac1e3af516241 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>apache_note</refname>
<refpurpose>Lit et affecte les notes de requête 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>
Cette fonction est une enveloppe pour les commandes <literal>table_get</literal> et
<literal>table_set</literal> d'Apache. Elle édite la table des notes qui existe lors d'une
requête. Le but de cette table est de permettre aux modules Apache de communiquer.
</para>
<para>
L'utilité de la fonction <function>apache_note</function> est de passer des informations
d'un module vers un autre, durant la même requête.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>note_name</parameter></term>
<listitem>
<para>
Le nom de la note.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>note_value</parameter></term>
<listitem>
<para>
La valeur de la note.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Si <parameter>note_value</parameter> est omis ou &null;, elle renvoie
la valeur courante de la variable <literal>note_name</literal>. Sinon,
elle affecte à la note <literal>note_name</literal>
la valeur <literal>note_value</literal> et
retourne la valeur précédente de la variable <literal>note_name</literal>.
Si la note ne peut être récupérée, &false; est retourné.
</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> est désormais nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Passage d'informations entre PHP et Perl</title>
<programlisting role="php">
<![CDATA[
<?php
apache_note('name', 'Fredrik Ekengren');
// Appel du script Perl
virtual("/perl/some_script.pl");
$result = apache_note("resultdata");
?>
]]>
</programlisting>
<programlisting role="perl">
<![CDATA[
# Récupération de l'objet de demande Apache
my $r = Apache->request()->main();
# Récupération des données passées
my $name = $r->notes('name');
# Des traitements
# Envoi du résultat vers PHP
$r->notes('resultdata', $result);
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Enregistrement de valeurs dans access.log</title>
<programlisting role="php">
<![CDATA[
<?php
apache_note('sessionID', session_id());
?>
]]>
</programlisting>
<programlisting role="apache">
<![CDATA[
# "%{sessionID}n" peut être utilisé dans la directive 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
-->