Class JSessionStorageXcache

Description

XCache session storage handler

  • since: 11.1

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

JObject
   |
   --JSessionStorage
      |
      --JSessionStorageXcache
Method Summary
static boolean test ()
JSessionStorageXcache __construct ([array $options = array()])
boolean destroy (string $id)
string read (string $id)
boolean write (string $id, string $session_data)
Variables

Inherited Variables

Inherited from JSessionStorage

JSessionStorage::$instances

Inherited from JObject

JObject::$_errors
Methods
static method test (line 102)

Test to see if the SessionHandler is available.

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

Redefinition of:
JSessionStorage::test()
Test to see if the SessionHandler is available.
Constructor __construct (line 28)

Constructor

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

Redefinition of:
JSessionStorage::__construct()
Constructor
destroy (line 85)

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.

Redefinition of:
JSessionStorage::destroy()
Destroy the data for a particular session identifier in the SessionHandler backend.
read (line 47)

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.

Redefinition of:
JSessionStorage::read()
Read the data for a particular session identifier from the SessionHandler backend.
write (line 70)

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.

Redefinition of:
JSessionStorage::write()
Write session data to the SessionHandler backend.

Inherited Methods

Inherited From JSessionStorage

JSessionStorage::__construct()
JSessionStorage::close()
JSessionStorage::destroy()
JSessionStorage::gc()
JSessionStorage::getInstance()
JSessionStorage::open()
JSessionStorage::read()
JSessionStorage::register()
JSessionStorage::test()
JSessionStorage::write()

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 14:01:39 -0500 by phpDocumentor 1.4.4