Class SessionHandler_memcache

Description

SessionHandler:: implementation for memcache.

NOTE FOR WINDOWS USERS w/PHP 4: Due to limitations in PHP 4, you should not use the memcache driver. Either upgrade to PHP 5 or use a different session handler.

Optional parameters:

   'persistent_driver' - (string) If set, uses this backend to store session
                         data persistently.
   'persistent_params' - (array) If using a persistent backend, the params
                         to use for the persistent backend.
   'track'             - (boolean) Track active sessions?
   'track_lifetime'    - (integer) The number of seconds after which tracked
                         sessions will be treated as expired.

$Horde: framework/SessionHandler/SessionHandler/memcache.php,v 1.1.2.13 2009/10/06 22:22:20 slusarz Exp $

Copyright 2005-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /SessionHandler/SessionHandler/memcache.php (line 34)

SessionHandler
   |
   --SessionHandler_memcache
Variable Summary
 string $_id
 SessionHandler $_persistent
 boolean $_readonly
 string $_trackID
Method Summary
 SessionHandler_memcache SessionHandler_memcache ([array $params = array()])
 boolean destroy (string $id)
 boolean gc ([integer $maxlifetime = 300])
 array getSessionIDs ()
Variables
string $_id (line 48)

Current session ID.

Horde_Cache $_memcache (line 41)

Horde_Memcache object.

SessionHandler $_persistent (line 55)

Persistent backend driver.

boolean $_readonly = false (line 62)

Do read-only get?

string $_trackID = 'horde_memcache_sessions_track' (line 69)

The ID used for session tracking.

Inherited Variables

Inherited from SessionHandler

SessionHandler::$_connected
SessionHandler::$_force
SessionHandler::$_params
SessionHandler::$_sig
Methods
Constructor SessionHandler_memcache (line 76)

Constructs a new Memcache SessionHandler object.

SessionHandler_memcache SessionHandler_memcache ([array $params = array()])
  • array $params: A hash containing connection parameters.
destroy (line 243)

Destroy the data for a particular session identifier.

  • return: True on success, false otherwise.
boolean destroy (string $id)
  • string $id: The session identifier.

Redefinition of:
SessionHandler::destroy()
Destroy the data for a particular session identifier in the SessionHandler backend.
gc (line 278)

Garbage collect stale sessions from the SessionHandler backend.

  • return: True on success, false otherwise.
boolean gc ([integer $maxlifetime = 300])
  • integer $maxlifetime: The maximum age of a session.

Redefinition of:
SessionHandler::gc()
Garbage collect stale sessions from the SessionHandler backend.
getSessionIDs (line 295)

Get a list of (possibly) valid session identifiers.

  • return: A list of session identifiers or PEAR_Error.
array getSessionIDs ()

Redefinition of:
SessionHandler::getSessionIDs()
Get a list of the valid session identifiers.

Inherited Methods

Inherited From SessionHandler

 SessionHandler::SessionHandler()
 SessionHandler::close()
 SessionHandler::countAuthenticatedUsers()
 SessionHandler::destroy()
 SessionHandler::factory()
 SessionHandler::gc()
 SessionHandler::getSessionIDs()
 SessionHandler::getSessionsInfo()
 SessionHandler::listAuthenticatedUsers()
 SessionHandler::open()
 SessionHandler::read()
 SessionHandler::singleton()
 SessionHandler::write()
 SessionHandler::__destruct()

Documentation generated on Sun, 30 Jan 2011 05:19:35 +0000 by phpDocumentor 1.4.3