reference/session/functions/session-cache-expire.xml
151e61773c016edcae8fd4989ad9a86ffd03c283
151e61773c016edcae8fd4989ad9a86ffd03c283
...
...
@@ -1,16 +1,16 @@
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-expire'>
3
+
<refentry xml:id="function.session-cache-expire" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>session_cache_expire</refname>
6
-
<refpurpose>Return current cache expire</refpurpose>
6
+
<refpurpose>Get and/or set current cache expire</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>session_cache_expire</methodname>
13
-
<methodparam choice="opt"><type>string</type><parameter>new_cache_expire</parameter></methodparam>
12
+
<type class="union"><type>int</type><type>false</type></type><methodname>session_cache_expire</methodname>
13
+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>session_cache_expire</function> returns the current setting of
...
...
@@ -30,16 +30,16 @@
30
30
<para>
31
31
<variablelist>
32
32
<varlistentry>
33
-
<term><parameter>new_cache_expire</parameter></term>
33
+
<term><parameter>value</parameter></term>
34
34
<listitem>
35
35
<para>
36
-
If <parameter>new_cache_expire</parameter> is given, the current cache
37
-
expire is replaced with <parameter>new_cache_expire</parameter>.
36
+
If <parameter>value</parameter> is given and not &null;, the current cache
37
+
expire is replaced with <parameter>value</parameter>.
38
38
</para>
39
39
<para>
40
40
<note>
41
41
<simpara>
42
-
Setting <parameter>new_cache_expire</parameter> is of value only, if
42
+
Setting <parameter>value</parameter> is of value only, if
43
43
<literal>session.cache_limiter</literal> is set to a value
44
44
<emphasis>different</emphasis> from <literal>nocache</literal>.
45
45
</simpara>
...
...
@@ -56,9 +56,32 @@
56
56
<para>
57
57
Returns the current setting of <literal>session.cache_expire</literal>.
58
58
The value returned should be read in minutes, defaults to 180.
59
+
On failure to change the value, &false; is returned.
59
60
</para>
60
61
</refsect1>
61
62
63
+
<refsect1 role="changelog">
64
+
&reftitle.changelog;
65
+
<informaltable>
66
+
<tgroup cols="2">
67
+
<thead>
68
+
<row>
69
+
<entry>&Version;</entry>
70
+
<entry>&Description;</entry>
71
+
</row>
72
+
</thead>
73
+
<tbody>
74
+
<row>
75
+
<entry>8.0.0</entry>
76
+
<entry>
77
+
<parameter>value</parameter> is nullable now.
78
+
</entry>
79
+
</row>
80
+
</tbody>
81
+
</tgroup>
82
+
</informaltable>
83
+
</refsect1>
84
+
62
85
<refsect1 role="examples">
63
86
&reftitle.examples;
64
87
<para>
...
...
@@ -102,7 +125,6 @@ echo "The cached session pages expire after $cache_expire minutes";
102
125
</refsect1>
103
126
104
127
</refentry>
105
-
106
128
<!-- Keep this comment at the end of the file
107
129
Local variables:
108
130
mode: sgml
109
131