Actions

API16

JSession/destroy

From Joomla! Documentation

< API16:JSession
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Frees all session variables and destroys all data registered to a session

[Edit Descripton]

Description:JSession/destroy

Syntax

destroy()


Returns

void

Defined in

libraries/joomla/session/session.php

Importing

jimport( 'joomla.session.session' );

Source Body

public function destroy()
{
        // session was already destroyed
        if ($this->_state === 'destroyed') {
                return true;
        }
 
        // In order to kill the session altogether, like to log the user out, the session id
        // must also be unset. If a cookie is used to propagate the session id (default behavior),
        // then the session cookie must be deleted.
        if (isset($_COOKIE[session_name()])) {
                $config =& JFactory::getConfig();
                $cookie_domain = $config->getValue('config.cookie_domain', '');
                $cookie_path = $config->getValue('config.cookie_path', '/');
                setcookie(session_name(), '', time()-42000, $cookie_path, $cookie_domain);
        }
 
        session_unset();
        session_destroy();
 
        $this->_state = 'destroyed';
        return true;
}

[Edit See Also] SeeAlso:JSession/destroy

Examples

<CodeExamplesForm />