API Documentation
\

\Horde_Core_HashTable_PersistentSession

Hashtable implementation that ensures persistency of data within a given session, without using session storage. Instead, VFS is used to store the data.

The data is attempted to be removed at the end of the session, so there is no guarantee of persistence across sessions.

Summary

Methods
Properties
Constants
__construct()
getStream()
gc()
set()
logoutTask()
No public properties found
SESS_KEY
VFS_PATH
_get()
_set()
_getKeys()
$_stream
N/A
No private methods found
No private properties found
N/A

Constants

SESS_KEY

SESS_KEY

Session data storage key.

VFS_PATH

VFS_PATH

The virtual path to use for VFS data (temporary storage).

Properties

$_stream

$_stream : boolean

Return get data as stream objects?

Type

boolean

Methods

__construct()

__construct(array  $params = array())

Parameters

array $params

getStream()

getStream(mixed  $keys) : mixed

Get data associated with a key(s).

Parameters

mixed $keys

The key or an array of keys.

Returns

mixed —

The string/array on success (return type is the type of $keys); Horde_Stream objects are returned on success, false value(s) on failure.

gc()

gc(integer  $expire)

Perform garbage collection on the VFS path.

Parameters

integer $expire

Expire entries older than this value (in seconds).

set()

set(  $key,   $val, array  $opts = array())

Parameters

$key
$val
array $opts

logoutTask()

logoutTask()

Function to run on logout.

_get()

_get(  $keys)

Parameters

$keys

_set()

_set(  $key,   $val, array  $opts)

Parameters

$key
$val
array $opts

Additional option honored in this driver:

  • filename: (boolean) If true, $val is a filename containing the data to be saved rather than the data itself.

_getKeys()

_getKeys() : array

Return the list of keys that have been saved to VFS this session.

Returns

array —

List of keys.