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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 328095 $ -->
<refentry xml:id="sessionhandler.gc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SessionHandler::gc</refname>
<refpurpose>Cleanup old sessions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SessionHandler::gc</methodname>
<methodparam><type>int</type><parameter>maxlifetime</parameter></methodparam>
</methodsynopsis>
<para>
Cleans up expired sessions. Called randomly by PHP internally when a session starts or when
<function>session_start</function> is invoked. The frequency this is called is
based on the <link linkend="ini.session.gc-divisor">session.gc_divisor</link> and
<link linkend="ini.session.gc-probability">session.gc_probability</link> configuration
directives.
</para>
<para>
This method wraps the internal PHP save handler defined in the
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
before this handler was set by <function>session_set_save_handler</function>.
</para>
<para>
If this class is extended by inheritiance, calling the parent <parameter>gc</parameter> method will invoke the
wrapper for this method and therefor invoke the associated internal callback. This allows this method to be
overidden and or intercepted and filtered.
</para>
<para>
For more information on what this method is expected to do, please refer to the documentation at
<function>SessionHandlerInterface::gc</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>maxlifetime</parameter></term>
<listitem>
<para>
Sessions that have not updated for the last <parameter>maxlifetime</parameter> seconds will be removed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&returns.session.storage.retval;
</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
-->
|
