Class JSessionStorage

Description

Custom session storage handler for PHP

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

JObject
   |
   --JSessionStorage
Direct descendents
Class Description
JSessionStorageApc APC session storage handler for PHP
JSessionStorageWincache WINCACHE session storage handler for PHP
JSessionStorageNone File session handler for PHP
JSessionStorageXcache XCache session storage handler
JSessionStorageDatabase Database session storage handler for PHP
JSessionStorageEaccelerator eAccelerator session storage handler for PHP
JSessionStorageMemcache Memcache session storage handler for PHP
Variable Summary
static array $instances
Method Summary
static JSessionStorage getInstance ([string $name = 'none'], [array $options = array()])
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

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
static method 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 method test (line 189)

Test to see if the SessionHandler is available.

  • return: True on success, false otherwise.
  • since: 11.1
  • access: public
static boolean test ()

Redefined in descendants as:
Constructor __construct (line 36)

Constructor

  • since: 11.1
  • access: public
JSessionStorage __construct ([array $options = array()])
  • array $options: Optional parameters.

Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.

Redefined in descendants as:
close (line 118)

Close the SessionHandler backend.

  • return: True on success, false otherwise.
  • since: 11.1
  • access: public
boolean close ()

Redefined in descendants as:
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:
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:
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.

Redefined in descendants as:
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:
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:
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:

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:59:47 -0500 by phpDocumentor 1.4.4