reference/apache/functions/apache-note.xml
a331ac8a86bb5929b79be9a369fac1e3af516241
...
...
@@ -9,13 +9,9 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>apache_note</methodname>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>apache_note</methodname>
13
13
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
14
-
</methodsynopsis>
15
-
<methodsynopsis>
16
-
<type>string</type><methodname>apache_note</methodname>
17
-
<methodparam><type>string</type><parameter>note_name</parameter></methodparam>
18
-
<methodparam><type>string</type><parameter>note_value</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>note_value</parameter><initializer>&null;</initializer></methodparam>
19
15
</methodsynopsis>
20
16
<para>
21
17
This function is a wrapper for Apache's <literal>table_get</literal> and
...
...
@@ -56,8 +52,8 @@
56
52
<refsect1 role="returnvalues">
57
53
&reftitle.returnvalues;
58
54
<para>
59
-
If called with one argument, it returns the current value of note
60
-
<literal>note_name</literal>. If called with two arguments, it
55
+
If <parameter>note_value</parameter> is omitted or &null;, it returns the current value of note
56
+
<literal>note_name</literal>. Otherwise, it
61
57
sets the value of note <literal>note_name</literal> to
62
58
<literal>note_value</literal> and returns the previous value of
63
59
note <literal>note_name</literal>.
...
...
@@ -65,6 +61,28 @@
65
61
</para>
66
62
</refsect1>
67
63

64
+
<refsect1 role="changelog">
65
+
&reftitle.changelog;
66
+
<informaltable>
67
+
<tgroup cols="2">
68
+
<thead>
69
+
<row>
70
+
<entry>&Version;</entry>
71
+
<entry>&Description;</entry>
72
+
</row>
73
+
</thead>
74
+
<tbody>
75
+
<row>
76
+
<entry>8.0.0</entry>
77
+
<entry>
78
+
<parameter>note_value</parameter> is nullable now.
79
+
</entry>
80
+
</row>
81
+
</tbody>
82
+
</tgroup>
83
+
</informaltable>
84
+
</refsect1>
85
+

68
86
<refsect1 role="examples">
69
87
&reftitle.examples;
70
88
<para>
...
...
@@ -130,7 +148,6 @@ apache_note('sessionID', session_id());
130
148
</refsect1>
131
149

132
150
</refentry>
133
-

134
151
<!-- Keep this comment at the end of the file
135
152
Local variables:
136
153
mode: sgml
137
154