Documentation

Horde_Prefs_Cache_Session extends Horde_Prefs_Cache_Base
in package

Session cache implementation for the preferences system.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$_key  : string
Session key.
$_params  : string
Configuration parameters.
__construct()  : mixed
Constructor.
get()  : mixed
Retrieves the requested preferences scope from the cache backend.
remove()  : mixed
Removes preferences from the cache.
store()  : mixed
Stores preferences in the cache backend.

Properties

$_key

Session key.

protected string $_key

$_params

Configuration parameters.

protected string $_params = array()

'user' is always available as an entry.

Methods

__construct()

Constructor.

public __construct(mixed $user[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$user : mixed

The username.

$params : array<string|int, mixed> = array()

Additional configuration parameters.

Return values
mixed

get()

Retrieves the requested preferences scope from the cache backend.

public get(mixed $scope) : mixed
Parameters
$scope : mixed

Scope specifier.

Return values
mixed

Returns false if no data is available, otherwise the Horde_Prefs_Scope object.

remove()

Removes preferences from the cache.

public remove([mixed $scope = null ]) : mixed
Parameters
$scope : mixed = null

The scope to remove. If null, clears entire cache.

Return values
mixed

store()

Stores preferences in the cache backend.

public store(mixed $scope_ob) : mixed
Parameters
$scope_ob : mixed

The scope object to store.

Return values
mixed

Search results