reference/session/sessionhandlerinterface/gc.xml
601f6f4ce5827d441a7e110184708f0abe9fd447
601f6f4ce5827d441a7e110184708f0abe9fd447
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="sessionhandlerinterface.gc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>SessionHandlerInterface::gc</refname>
...
...
@@ -9,9 +8,9 @@
9
8
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionHandlerInterface::gc</methodname>
14
-
<methodparam><type>int</type><parameter>maxlifetime</parameter></methodparam>
11
+
<methodsynopsis role="SessionHandlerInterface">
12
+
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SessionHandlerInterface::gc</methodname>
13
+
<methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>
15
14
</methodsynopsis>
16
15
<para>
17
16
Cleans up expired sessions. Called by <function>session_start</function>,
...
...
@@ -25,10 +24,10 @@
25
24
&reftitle.parameters;
26
25
<variablelist>
27
26
<varlistentry>
28
-
<term><parameter>maxlifetime</parameter></term>
27
+
<term><parameter>max_lifetime</parameter></term>
29
28
<listitem>
30
29
<para>
31
-
Sessions that have not updated for the last <parameter>maxlifetime</parameter> seconds will be removed.
30
+
Sessions that have not updated for the last <parameter>max_lifetime</parameter> seconds will be removed.
32
31
</para>
33
32
</listitem>
34
33
</varlistentry>
...
...
@@ -38,12 +37,34 @@
38
37
<refsect1 role="returnvalues">
39
38
&reftitle.returnvalues;
40
39
<para>
41
-
&returns.session.storage.retval;
40
+
Returns the number of deleted sessions on success, &return.falseforfailure;.
41
+
Note this value is returned internally to PHP for processing.
42
42
</para>
43
43
</refsect1>
44
44
45
-
</refentry>
45
+
<refsect1 role="changelog">
46
+
&reftitle.changelog;
47
+
<informaltable>
48
+
<tgroup cols="2">
49
+
<thead>
50
+
<row>
51
+
<entry>&Version;</entry>
52
+
<entry>&Description;</entry>
53
+
</row>
54
+
</thead>
55
+
<tbody>
56
+
<row>
57
+
<entry>7.1.0</entry>
58
+
<entry>
59
+
Prior to this version, the function returned &true; on success.
60
+
</entry>
61
+
</row>
62
+
</tbody>
63
+
</tgroup>
64
+
</informaltable>
65
+
</refsect1>
46
66
67
+
</refentry>
47
68
<!-- Keep this comment at the end of the file
48
69
Local variables:
49
70
mode: sgml
50
71