Class JSessionHandlerNative

Interface for managing HTTP sessions

JSessionHandlerNative implements JSessionHandlerInterface

Direct known subclasses

JSessionHandlerJoomla

Package: Joomla\Platform\Session
Deprecated: 4.0 The CMS' Session classes will be replaced with the joomla/session package
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 3.5
Located at joomla/session/handler/native.php

Methods summary

`public boolean`	# `start( )` Starts the session Starts the session Returns `boolean` - True if started Throws `RuntimeException` - If something goes wrong starting the session. Since 3.5 Implementation of `JSessionHandlerInterface::start()`
`public boolean`	# `isStarted( )` Checks if the session is started. Checks if the session is started. Returns `boolean` - True if started, false otherwise. Since 3.5 Implementation of `JSessionHandlerInterface::isStarted()`
`public string`	# `getId( )` Returns the session ID Returns the session ID Returns `string` - The session ID Since 3.5 Implementation of `JSessionHandlerInterface::getId()`
`public`	# `setId( string $id )` Sets the session ID Sets the session ID Parameters `$id` `string` - $id The session ID Throws `LogicException` Since 3.5 Implementation of `JSessionHandlerInterface::setId()`
`public mixed`	# `getName( )` Returns the session name Returns the session name Returns `mixed` - The session name Since 3.5 Implementation of `JSessionHandlerInterface::getName()`
`public`	# `setName( string $name )` Sets the session name Sets the session name Parameters `$name` `string` - $name The name of the session Throws `LogicException` Since 3.5 Implementation of `JSessionHandlerInterface::setName()`
`public boolean`	# `regenerate( boolean $destroy = false, integer $lifetime = null )` Regenerates ID that represents this storage. Regenerates ID that represents this storage. Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage. Parameters `$destroy` `boolean` - $destroy Destroy session when regenerating? `$lifetime` `integer` - $lifetime Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp. Returns `boolean` - True if session regenerated, false if error Since 3.5 Implementation of `JSessionHandlerInterface::regenerate()`
`public`	# `save( )` Force the session to be saved and closed. Force the session to be saved and closed. This method must invoke session_write_close() unless this interface is used for a storage object design for unit or functional testing where a real PHP session would interfere with testing, in which case it should actually persist the session data if required. Throws `RuntimeException` - If the session is saved without being started, or if the session is already closed. Since 3.5 See session_write_close() Implementation of `JSessionHandlerInterface::save()`
`public`	# `clear( )` Clear all session data in memory. Clear all session data in memory. Since 3.5 Implementation of `JSessionHandlerInterface::clear()`

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JSessionHandlerNative

Direct known subclasses

Methods summary

Returns

Throws

Since

Implementation of

Returns

Since

Implementation of

Returns

Since

Implementation of

Parameters

Throws

Since

Implementation of

Returns

Since

Implementation of

Parameters

Throws

Since

Implementation of

Parameters

Returns

Since

Implementation of

Throws

Since

See

Implementation of

Since

Implementation of

Magic methods summary