Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JSessionStorageMemcache

Description
Description | Variables (details) | Methods (details)

Memcache session storage handler for PHP

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

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

Class JObject   (Subpackage Base)

Abstract class JSessionStorage
   
   Class JSessionStorageMemcache   (Subpackage Session)
Variable Summary
Description | Variables (details) | Methods (details)
Variable int $_compress
Variable resource $_db
Variable boolean $_persistent
Method Summary
Description | Variables (details) | Methods (details)
Static method static boolean test ()
Constructor JSessionStorageMemcache __construct ([array $options = array()])
Method boolean close ()
Method boolean destroy (string $id)
Method boolean gc (integer $maxlifetime)
Method boolean open (string $save_path, string $session_name)
Method string read (string $id)
Method boolean write (string $id, string $session_data)
Variables
Description | Variables (details) | Methods (details)
int $_compress = null (line 42)

Use compression?

resource $_db (line 35)

Resource for the current memcached connection.

boolean $_persistent = false (line 49)

Use persistent connections

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 57)

Constructor

  • access: protected
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 161)

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

  • return: True on success, false otherwise.
  • 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.
gc (line 177)

Garbage collect stale sessions from the SessionHandler backend.

-- Not Applicable in memcache --

  • return: True on success, false otherwise.
  • access: public
boolean gc (integer $maxlifetime)
  • integer $maxlifetime: The maximum age of a session.
Redefinition of:
JSessionStorage::gc()
Garbage collect stale sessions from the SessionHandler backend.
open (line 92)

Open the SessionHandler backend.

  • return: True on success, false otherwise.
  • 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 122)

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

  • return: The session data.
  • 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.
test (line 189)

Test to see if the SessionHandler is available.

  • return: True on success, false otherwise.
  • access: public
boolean test ()
Redefinition of:
JSessionStorage::test()
Test to see if the SessionHandler is available.
write (line 137)

Write session data to the SessionHandler backend.

  • return: True on success, false otherwise.
  • 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::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
Documentation generated on Mon, 22 Sep 2008 12:10:45 +0100 by phpDocumentor 1.3.1