Docs For Class JSessionStorage

Description

Custom session storage handler for PHP

see: http://www.php.net/manual/en/function.session-set-save-handler.php
todo: When dropping compatibility with PHP 5.3 use the SessionHandlerInterface and the SessionHandler class
abstract:
since: 11.1

Located in /libraries/joomla/session/storage.php (line 21)

Direct descendents

Class	Description
JSessionStorageApc	APC session storage handler for PHP
JSessionStorageDatabase	Database session storage handler for PHP
JSessionStorageMemcache	Memcache session storage handler for PHP
JSessionStorageMemcached	Memcached session storage handler for PHP
JSessionStorageNone	File session handler for PHP
JSessionStorageWincache	WINCACHE session storage handler for PHP
JSessionStorageXcache	XCache session storage handler

Variable Summary

static array $instances

Method Summary

static JSessionStorage getInstance ([string $name = 'none'], [array $options = array()])

static boolean isSupported ()

static boolean test ()

JSessionStorage __construct ([array $options = array()])

boolean close ()

boolean destroy (string $id)

boolean gc ([integer $maxlifetime = null])

boolean open (string $save_path, string $session_name)

string read (string $id)

void register ()

boolean write (string $id, string $session_data)

Variables

static array $instances = array() (line 27)

var: JSessionStorage instances container.
since: 11.3
access: protected

Methods

static getInstance (line 51)

Returns a session storage handler object, only creating it if it doesn't already exist.

since: 11.1
access: public

static JSessionStorage getInstance ([string $name = 'none'], [array $options = array()])

string $name: The session store to instantiate
array $options: Array of options

static isSupported (line 189)

Test to see if the SessionHandler is available.

return: True on success, false otherwise.
since: 12.1
access: public

static boolean isSupported ()

Redefined in descendants as:

JSessionStorageApc::isSupported() : Test to see if the SessionHandler is available.
JSessionStorageMemcache::isSupported() : Test to see if the SessionHandler is available.
JSessionStorageMemcached::isSupported() : Test to see if the SessionHandler is available.
JSessionStorageWincache::isSupported() : Test to see if the SessionHandler is available.
JSessionStorageXcache::isSupported() : Test to see if the SessionHandler is available.

static test (line 202)

Test to see if the SessionHandler is available.

return: True on success, false otherwise.
deprecated: 12.3 (Platform) & 4.0 (CMS) - Use JSessionStorage::isSupported() instead.
since: 11.1
access: public

static boolean test ()

Constructor __construct (line 36)

Constructor

since: 11.1
access: public

JSessionStorage __construct ([array $options = array()])

array $options: Optional parameters.

Redefined in descendants as:

JSessionStorageApc::__construct() : Constructor
JSessionStorageMemcache::__construct() : Constructor
JSessionStorageMemcached::__construct() : Constructor
JSessionStorageWincache::__construct() : Constructor
JSessionStorageXcache::__construct() : Constructor

close (line 118)

Close the SessionHandler backend.

return: True on success, false otherwise.
since: 11.1
access: public

boolean close ()

destroy (line 163)

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

return: True on success, false otherwise.
since: 11.1
access: public

boolean destroy (string $id)

string $id: The session identifier.

Redefined in descendants as:

JSessionStorageApc::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.
JSessionStorageDatabase::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.
JSessionStorageXcache::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.

gc (line 177)

Garbage collect stale sessions from the SessionHandler backend.

return: True on success, false otherwise.
since: 11.1
access: public

boolean gc ([integer $maxlifetime = null])

integer $maxlifetime: The maximum age of a session.

Redefined in descendants as:

JSessionStorageDatabase::gc() : Garbage collect stale sessions from the SessionHandler backend.

open (line 106)

Open the SessionHandler backend.

return: True on success, false otherwise.
since: 11.1
access: public

boolean open (string $save_path, string $session_name)

string $save_path: The path to the session object.
string $session_name: The name of the session.

read (line 133)

Read the data for a particular session identifier from the SessionHandler backend.

return: The session data.
since: 11.1
access: public

string read (string $id)

string $id: The session identifier.

Redefined in descendants as:

JSessionStorageApc::read() : Read the data for a particular session identifier from the SessionHandler backend.
JSessionStorageDatabase::read() : Read the data for a particular session identifier from the SessionHandler backend.
JSessionStorageXcache::read() : Read the data for a particular session identifier from the SessionHandler backend.

register (line 87)

Register the functions of this class with PHP's session handler

since: 11.1
access: public

void register ()

Redefined in descendants as:

JSessionStorageMemcache::register() : Register the functions of this class with PHP's session handler
JSessionStorageMemcached::register() : Register the functions of this class with PHP's session handler
JSessionStorageNone::register() : Register the functions of this class with PHP's session handler
JSessionStorageWincache::register() : Register the functions of this class with PHP's session handler

write (line 148)

Write session data to the SessionHandler backend.

return: True on success, false otherwise.
since: 11.1
access: public

boolean write (string $id, string $session_data)

string $id: The session identifier.
string $session_data: The session data.

Redefined in descendants as:

JSessionStorageApc::write() : Write session data to the SessionHandler backend.
JSessionStorageDatabase::write() : Write session data to the SessionHandler backend.
JSessionStorageXcache::write() : Write session data to the SessionHandler backend.