mirror of
https://github.com/php/doc-fr.git
synced 2026-03-24 07:02:06 +01:00
107 lines
3.5 KiB
XML
107 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
<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>Nettoie les anciennes 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>
|
|
Nettoie les sessions expirées. Appelé aléatoirement en interne par PHP lorsqu'une
|
|
session démarre ou lorsque la fonction <function>session_start</function> est appelée.
|
|
La fréquence d'appel est basée sur les directives de configuration
|
|
<link linkend="ini.session.gc-divisor">session.gc_divisor</link> et
|
|
<link linkend="ini.session.gc-probability">session.gc_probability</link>.
|
|
</para>
|
|
<para>
|
|
Cette méthode se substitue au gestionnaire interne de sauvegarde PHP défini via l'option
|
|
de configuration <link linkend="ini.session.save-handler">session.save_handler</link>
|
|
qui a été définie avant que ce dernier ne le soit via la fonction
|
|
<function>session_set_save_handler</function>.
|
|
</para>
|
|
<para>
|
|
Si cette classe est étendue par héritage, l'appel à la méthode parente <parameter>gc</parameter>
|
|
invoquera l'enveloppe pour cette méthode, mais aussi, invoquera en interne la fonction de rappel
|
|
associée. Ce comportement permet à cette méthode d'être surchargée ou bien d'être interceptée
|
|
et filtrée.
|
|
</para>
|
|
<para>
|
|
Pour plus d'informations sur l'attendu de cette méthode, se référer à la documentation
|
|
sur la fonction <function>SessionHandlerInterface::gc</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>max_lifetime</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Les sessions qui n'auront pas été mises à jour les dernières
|
|
<parameter>max_lifetime</parameter> secondes seront supprimées.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retourne le nombre de sessions supprimées en cas de succès, &return.falseforfailure;.
|
|
Il est à noter que cette valeur est retournée en interne à PHP pour traitement.
|
|
</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>
|
|
Antérieur à cette version, cette fonction retournait &true; en cas de succès.
|
|
</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
|
|
-->
|