destroy.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="sessionhandler.destroy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SessionHandler::destroy</refname>
  <refpurpose>Détruit une session</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="SessionHandler">
   <modifier>public</modifier> <type>bool</type><methodname>SessionHandler::destroy</methodname>
   <methodparam><type>string</type><parameter>id</parameter></methodparam>
  </methodsynopsis>
  <para>
   Détruit une session. Cette fonction est appelée en interne par PHP au moyen de
   <function>session_regenerate_id</function> (en supposant que <parameter>$destory</parameter> est
   mis à &true;) <function>session_destroy</function> ou lorsque la fonction
   <function>session_decode</function> échoue.
  </para>
  <para>
   Cette méthode se substitut au gestionnaire interne de sauvegarde de PHP défini via l'option
   de configuration <link linkend="ini.session.save-handler">session.save_handler</link> qui a été
   définie avant celui défini via la fonction <function>session_set_save_handler</function>.
  </para>
  <para>
   Si cette classe est étendue, appeler la méthode parente <parameter>destroy</parameter> invoquera
   le gestionnaire de cette méthode et donc la fonction interne à PHP.
  </para>
  <para>
   Pour plus d'informations sur l'attendu de cette méthode, référez-vous à la documentation
   de la fonction <function>SessionHandlerInterface::destroy</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>id</parameter></term>
     <listitem>
      <para>
       L'ID de la session à détruire.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </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
-->