API Documentation
\

\Horde_Prefs_Cache_Base

Cache driver for the preferences system.

Summary

Methods
Properties
Constants
__construct()
get()
store()
remove()
No public properties found
No constants found
No protected methods found
$_params
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : string

Configuration parameters.

'user' is always available as an entry.

Type

string

Methods

__construct()

__construct(string  $user, array  $params = array())

Constructor.

Parameters

string $user

The username.
array $params

Additional configuration parameters.

get()

get(string  $scope) : mixed

Retrieves the requested preferences scope from the cache backend.

Parameters

string $scope

Scope specifier.

Throws

\Horde_Prefs_Exception

Returns

mixed —

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

store()

store(\Horde_Prefs_Scope  $scope_ob)

Stores preferences in the cache backend.

Parameters

\Horde_Prefs_Scope $scope_ob

The scope object to store.

Throws

\Horde_Prefs_Exception

remove()

remove(string  $scope = null)

Removes preferences from the cache.

Parameters

string $scope

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

Throws

\Horde_Prefs_Exception