PHP Class Horde_Prefs_Storage_Base, horde

Author: Michael Slusarz ([email protected])

Protected Properties

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

Method	Description
__construct ( string $user, array $params = [] )	Constructor.
get ( Horde_Prefs_Scope $scope_ob ) : Horde_Prefs_Scope	Retrieves the requested preferences scope from the storage backend.
getParams ( ) : array	Get the list of driver parameters.
listScopes ( ) : array	Lists all available scopes.
onChange ( string $scope, string $pref )	Called whenever a preference value is changed.
remove ( string $scope = null, string $pref = null )	Removes preferences from the backend.
store ( Horde_Prefs_Scope $scope_ob )	Stores changed preferences in the storage backend.

Constructor.

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

Retrieves the requested preferences scope from the storage backend.

abstract public get ( Horde_Prefs_Scope $scope_ob ) : Horde_Prefs_Scope
$scope_ob	Horde_Prefs_Scope	The scope object.
return	Horde_Prefs_Scope	The modified scope object.

Get the list of driver parameters.

public getParams ( ) : array
return	array	Driver parameters.

Lists all available scopes.

public listScopes ( ) : array
return	array	The list of scopes stored in the backend.

Called whenever a preference value is changed.

public onChange ( string $scope, string $pref )
$scope	string	Scope specifier.
$pref	string	The preference name.

Removes preferences from the backend.

abstract public remove ( string $scope = null, string $pref = null )
$scope	string	The scope of the prefs to clear. If null, clears all scopes.
$pref	string	The pref to clear. If null, clears the entire scope.

Stores changed preferences in the storage backend.

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

'user' is always available as an entry.

protected string $_params
return	string