reference/session/functions/session-cache-limiter.xml
151e61773c016edcae8fd4989ad9a86ffd03c283
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-cache-limiter">
3
+
<refentry xml:id="function.session-cache-limiter" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>session_cache_limiter</refname>
6
6
<refpurpose>Get and/or set the current cache limiter</refpurpose>
...
...
@@ -9,8 +9,8 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>session_cache_limiter</methodname>
13
-
<methodparam choice="opt"><type>string</type><parameter>cache_limiter</parameter></methodparam>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>session_cache_limiter</methodname>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>session_cache_limiter</function> returns the name of the
...
...
@@ -49,10 +49,10 @@
49
49
<para>
50
50
<variablelist>
51
51
<varlistentry>
52
-
<term><parameter>cache_limiter</parameter></term>
52
+
<term><parameter>value</parameter></term>
53
53
<listitem>
54
54
<para>
55
-
If <parameter>cache_limiter</parameter> is specified, the name of the
55
+
If <parameter>value</parameter> is specified and not &null;, the name of the
56
56
current cache limiter is changed to the new value.
57
57
</para>
58
58
<table>
...
...
@@ -125,9 +125,32 @@ Pragma: no-cache
125
125
&reftitle.returnvalues;
126
126
<para>
127
127
Returns the name of the current cache limiter.
128
+
On failure to change the value, &false; is returned.
128
129
</para>
129
130
</refsect1>
130
131

132
+
<refsect1 role="changelog">
133
+
&reftitle.changelog;
134
+
<informaltable>
135
+
<tgroup cols="2">
136
+
<thead>
137
+
<row>
138
+
<entry>&Version;</entry>
139
+
<entry>&Description;</entry>
140
+
</row>
141
+
</thead>
142
+
<tbody>
143
+
<row>
144
+
<entry>8.0.0</entry>
145
+
<entry>
146
+
<parameter>value</parameter> is nullable now.
147
+
</entry>
148
+
</row>
149
+
</tbody>
150
+
</tgroup>
151
+
</informaltable>
152
+
</refsect1>
153
+

131
154
<refsect1 role="examples">
132
155
&reftitle.examples;
133
156
<para>
...
...
@@ -160,7 +183,6 @@ echo "The cache limiter is now set to $cache_limiter<br />";
160
183
</refsect1>
161
184

162
185
</refentry>
163
-

164
186
<!-- Keep this comment at the end of the file
165
187
Local variables:
166
188
mode: sgml
167
189