Files
doc-fr/reference/session/functions/session-gc.xml
2021-06-12 05:58:25 +01:00

140 lines
4.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 35b95a56ccc03b66af7117fc815ac7881e2e0ad3 Maintainer: jbnahan Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.session-gc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_gc</refname>
<refpurpose>Exécute le ramasse miette des données de session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>session_gc</methodname>
<void/>
</methodsynopsis>
<para>
<function>session_gc</function> est utilisé pour exécuter le
ramasse miette (Garbage Collection abrégée GC). PHP utilise une
méthode probabiliste pour exécuter le ramasse miette de session par défaut.
</para>
<para>
Le ramassage de miette (GC) basé sur une méthode probabiliste fonctionne
quelque peu mais a quelques problèmes. 1) Les données de session des sites à
faible traffic ne seront peut être pas supprimés durant la durée préféré.
2) Les sites à fort traffic exécuteront potentiellement le ramasse miette
à une trop grande fréquence. 3) Le ramasse miette est exécuté sur une requête
utilisateur et celui-ci ressentira une latence due au ramasse miette.
</para>
<para>
Par conséquent, il est recommandé d'exécuter le ramasse miette périodiquement sur
les systèmes de productions, par exemple, "cron" pour les systèmes de type UNIX.
Assurez-vous de désactiver le ramasse miette à méthode probabiliste en définissant
<link linkend="ini.session.gc-probability">session.gc_probability</link>
à 0.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>session_gc</function> retourne le nombre de données de session
effacé en tant que succès, &false; en cas d'échec.
</para>
<para>
Les anciens gestionnaire de sauvegarde ne retourne pas le nombre de données
de session effacé mais seulement le drapeau de succès/échec. Dans ce cas là,
le nombre de données de session effacé est 1 quelque soit le nombre actuel
de données effacé.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple de <function>session_gc</function> pour les planificateurs de tâches comme cron</title>
<programlisting role="php">
<![CDATA[
<?php
// Note: Ce script devrait être exécuté par le même utilisateur que le processus du serveur web.
// Nécessite l'activation des sessions pour initialiser l'accès au gestionnaire de sauvegarde des sessions
session_start();
// Exécuter le Ramasse Miette immédiatement
session_gc();
// Effacer l'ID de session créé par session_gc()
session_destroy();
?>
]]>
</programlisting>
</example>
<example>
<title>Exemple de <function>session_gc</function> pour des scripts accessible par l'utilisateur</title>
<programlisting role="php">
<![CDATA[
<?php
// Note: il est recommandé que session_gc() soit utilisé par un planificateur de tâches,
// mais il peut être utilisé de la façon suivante.
// Utilisé pour vérifier l'heure de la dernière utilisation du ramasse miette
$gc_time = '/tmp/php_session_last_gc';
$gc_period = 1800;
session_start();
// Exécuter le ramasse miette seulement quand la période s'est écoulée.
// Appeler session_gc() à chaque requête est un gaspillage de ressource.
if (file_exists($gc_time)) {
if (filemtime($gc_time) < time() - $gc_period) {
session_gc();
touch($gc_time);
}
} else {
touch($gc_time);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>session_start</function></member>
<member><function>session_destroy</function></member>
<member><link linkend="ini.session.gc-probability">session.gc_probability</link></member>
</simplelist>
</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
-->