JSessionStorageDatabase/destroy

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Destroy the data for a particular session identifier in the SessionHandler backend.

[Edit Descripton]

Template:Description:JSessionStorageDatabase/destroy

Syntax[edit]

destroy($id)

Parameter Name	Default Value	Description
$id		The session identifier.

Returns[edit]

boolean True on success, false otherwise.

Defined in[edit]

libraries/joomla/session/storage/database.php

Importing[edit]

jimport( 'joomla.session.storage.database' );

Source Body[edit]

public function destroy($id)
{
        // Get the database connection object and verify its connected.
        $db = &JFactory::getDbo();
        if (!$db->connected()) {
                return false;
        }

        // Remove a session from the database.
        $db->setQuery(
                'DELETE FROM `#__session`' .
                ' WHERE `session_id` = '.$db->quote($id)
        );
        return (boolean) $db->query();
}

Examples[edit]

API16