Class JSessionStorageMemcache

Description

Memcache session storage handler for PHP

-- Inspired in both design and implementation by the Horde memcache handler --

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

JObject
   |
   --JSessionStorage
      |
      --JSessionStorageMemcache
Variable Summary
resource $_db
boolean $_persistent
Method Summary
static boolean test ()
JSessionStorageMemcache __construct ([array $options = array()])
boolean close ()
boolean destroy (string $id)
boolean open (string $save_path, string $session_name)
string read (string $id)
boolean write (string $id, string $session_data)
void _setExpire (string $key)
Variables
int $_compress = null (line 38)

Use compression?

  • since: 11.1
  • access: private
resource $_db (line 30)

Resource for the current memcached connection.

  • since: 11.1
  • access: private
boolean $_persistent = false (line 46)

Use persistent connections

  • since: 11.1
  • access: private

Inherited Variables

Inherited from JSessionStorage

JSessionStorage::$instances

Inherited from JObject

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

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 55)

Constructor

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

Redefinition of:
JSessionStorage::__construct()
Constructor
close (line 109)

Close the SessionHandler backend.

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

Redefinition of:
JSessionStorage::close()
Close the SessionHandler backend.
destroy (line 171)

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.
open (line 93)

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.

Redefinition of:
JSessionStorage::open()
Open the SessionHandler backend.
read (line 123)

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 140)

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.
_setExpire (line 197)

Set expire time on each call since memcache sets it on cache creation.

  • since: 11.1
  • access: protected
void _setExpire (string $key)
  • string $key: Cache key to expire.

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 13:56:43 -0500 by phpDocumentor 1.4.4