JApplicationCms::logout

Logout authentication function.

Passed the current user information to the onUserLogout event and reverts the current session record back to 'anonymous' parameters. If any of the authentication plugins did not successfully complete the logout routine then the whole method fails. Any errors raised should be done in the plugin as this provides the ability to give much more information about why the routine may have failed.

Signature

public function logout([integer
        $userid = null,
            array
        $options] )

Parameters

$userid: The user to load - Can be an integer or string - If string, it is converted to ID automatically
$options: Array('clientid' => array of client id's)

Returns

boolean: True on success