<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.session.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.session-gc.php',
    1 => 'session_gc',
    2 => 'Ex&eacute;cute le ramasse miette des donn&eacute;es de session',
  ),
  'up' => 
  array (
    0 => 'ref.session.php',
    1 => 'Fonctions Session',
  ),
  'prev' => 
  array (
    0 => 'function.session-encode.php',
    1 => 'session_encode',
  ),
  'next' => 
  array (
    0 => 'function.session-get-cookie-params.php',
    1 => 'session_get_cookie_params',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/session/functions/session-gc.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.session-gc" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">session_gc</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.1.0, PHP 8)</p><p class="refpurpose"><span class="refname">session_gc</span> &mdash; <span class="dc-title">Exécute le ramasse miette des données de session</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.session-gc-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>session_gc</strong></span>(): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Par défaut, PHP utilise <a href="session.configuration.php#ini.session.gc-probability" class="link">session.gc_probability</a>
   pour exécuter le ramasse miette des sessions de façon probabiliste à chaque
   requête. Il y a certaines limitations avec cette approche :
  </p>
  <ul class="simplelist">
   <li>Les sites à faible trafic peuvent ne pas avoir leurs données de session supprimées dans la durée préférée.</li>
   <li>Les sites à fort trafic peuvent voir le ramasse-miette s'exécuter trop fréquemment, effectuant un travail supplémentaire inutile.</li>
   <li>Le ramasse-miette est effectué lors de la requête de l'utilisateur, et l'utilisateur peut subir un délai.</li>
  </ul>
  <p class="simpara">
   Pour les systèmes de production, il est recommandé de désactiver
   le ramasse-miette basé sur la probabilité en configurant
   <a href="session.configuration.php#ini.session.gc-probability" class="link">session.gc_probability</a> à <code class="literal">0</code>
   et explicitement exécuter le ramasse-miette périodiquement, par exemple en utilisant &quot;cron&quot;
   sur les systèmes de type UNIX pour exécuter un script qui appelle <span class="function"><strong>session_gc()</strong></span>.
  </p>

  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    Lors de l&#039;appel de <span class="function"><strong>session_gc()</strong></span> depuis un script PHP en ligne de commande,
    le <a href="session.configuration.php#ini.session.save-path" class="link">session.save_path</a> doit être défini
    à la même valeur que pour les requêtes web, et le script doit avoir les permissions d&#039;accès et de suppression
    pour les fichiers de session. Cela peut être affecté par l&#039;utilisateur sous lequel le script s&#039;exécute,
    ainsi que par des fonctionnalités de conteneur ou de sandboxing telles que l&#039;option <code class="literal">PrivateTmp=</code>.
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.session-gc-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">Cette fonction ne contient aucun paramètre.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.session-gc-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="simpara">
   <span class="function"><strong>session_gc()</strong></span> renvoie le nombre d&#039;entrées de 
   sessions supprimées en cas de succès,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    Les vieux gestionnaires de sauvegarde de session ne renvoient pas le nombre d&#039;entrées de session supprimées, mais
    plutôt seulement un indicateur de succès/échec. Si c&#039;est le cas, <code class="literal">1</code> est renvoyé indépendamment
    du nombre d&#039;entrées de session réellement supprimées.
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 examples" id="refsect1-function.session-gc-examples">
  <h3 class="title">Exemples</h3>
  <div class="example" id="example-1">
   <p><strong>Exemple #1 Exemple de <span class="function"><strong>session_gc()</strong></span> pour les planificateurs de tâches comme cron</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// Note: Ce script devrait être exécuté par le même utilisateur que le processus du serveur web.<br /><br />// Nécessite l'activation des sessions pour initialiser l'accès au gestionnaire de sauvegarde des sessions<br /></span><span style="color: #0000BB">session_start</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Exécuter le Ramasse Miette immédiatement<br /></span><span style="color: #0000BB">session_gc</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Effacer l'ID de session créé par session_gc()<br /></span><span style="color: #0000BB">session_destroy</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>Exemple #2 Exemple de <span class="function"><strong>session_gc()</strong></span> pour des scripts accessibles par l&#039;utilisateur</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// Note: il est recommandé que session_gc() soit utilisé par un planificateur de tâches,<br />// mais il peut être utilisé de la façon suivante.<br /><br />// Utilisé pour vérifier l'heure de la dernière utilisation du ramasse miette<br /></span><span style="color: #0000BB">$gc_time </span><span style="color: #007700">= </span><span style="color: #DD0000">'/tmp/php_session_last_gc'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$gc_period </span><span style="color: #007700">= </span><span style="color: #0000BB">1800</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">session_start</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">// Exécuter le ramasse miette seulement quand la période s'est écoulée. <br />// Appeler session_gc() à chaque requête est un gaspillage de ressource.<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">file_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">)) {<br />    if (</span><span style="color: #0000BB">filemtime</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">) &lt; </span><span style="color: #0000BB">time</span><span style="color: #007700">() - </span><span style="color: #0000BB">$gc_period</span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">session_gc</span><span style="color: #007700">();<br />        </span><span style="color: #0000BB">touch</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">);<br />    }<br />} else {<br />    </span><span style="color: #0000BB">touch</span><span style="color: #007700">(</span><span style="color: #0000BB">$gc_time</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.session-gc-seealso">
  <h3 class="title">Voir aussi</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.session-start.php" class="function" rel="rdfs-seeAlso">session_start()</a> - D&eacute;marre une nouvelle session ou reprend une session existante</span></li>
   <li><span class="function"><a href="function.session-destroy.php" class="function" rel="rdfs-seeAlso">session_destroy()</a> - D&eacute;truit une session</span></li>
   <li><a href="session.configuration.php#ini.session.gc-probability" class="link">session.gc_probability</a></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>