mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
103 lines
3.2 KiB
XML
103 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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 role="SessionHandler">
|
|
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SessionHandler::gc</methodname>
|
|
<methodparam><type>int</type><parameter>max_lifetime</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 inheritance, calling the parent <parameter>gc</parameter> method will invoke the
|
|
wrapper for this method and therefore invoke the associated internal callback. This allows this method to be
|
|
overridden 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>max_lifetime</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Sessions that have not updated for the last <parameter>max_lifetime</parameter> seconds will be removed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the number of deleted sessions on success, &return.falseforfailure;.
|
|
Note this value is returned internally to PHP for processing.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>7.1.0</entry>
|
|
<entry>
|
|
Prior to this version, the function returned &true; on success.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</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
|
|
-->
|