PHP Class Horde_Prefs_Cache_Base, horde

Author: Michael Slusarz ([email protected])

Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_params	string	'user' is always available as an entry.

Public Methods

Method	Description
__construct ( string $user, array $params = [] )	Constructor.
get ( string $scope ) : mixed	Retrieves the requested preferences scope from the cache backend.
remove ( string $scope = null )	Removes preferences from the cache.
store ( Horde_Prefs_Scope $scope_ob )	Stores preferences in the cache backend.

Method Details

__construct() public method

Constructor.

public __construct ( string $user, array $params = [] )
$user	string	The username.
$params	array	Additional configuration parameters.

get() abstract public method

Retrieves the requested preferences scope from the cache backend.

abstract public get ( string $scope ) : mixed
$scope	string	Scope specifier.
return	mixed	Returns false if no data is available, otherwise the Horde_Prefs_Scope object.

remove() abstract public method

Removes preferences from the cache.

abstract public remove ( string $scope = null )
$scope	string	The scope to remove. If null, clears entire cache.

store() abstract public method

Stores preferences in the cache backend.

abstract public store ( Horde_Prefs_Scope $scope_ob )
$scope_ob	Horde_Prefs_Scope	The scope object to store.

Property Details

$_params protected property

'user' is always available as an entry.

protected string $_params
return	string