<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<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>Destroy a 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>

Destroys a session. Called internally by PHP with <function>session_regenerate_id</function> (assuming

the <parameter>$destroy</parameter> is set to &true;, by <function>session_destroy</function> or when

<function>session_decode</function> fails.

</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>destroy</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::destroy</function>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>id</parameter></term>

<listitem>

<para>

The session ID being destroyed.

</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

-->