PHP Class Horde_Prefs_Storage_Base, horde

Author: Michael Slusarz ([email protected])
Mostrar archivo 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 ( 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.

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 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.

getParams() public method

Get the list of driver parameters.
public getParams ( ) : array
return array Driver parameters.

listScopes() public method

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

onChange() public method

Called whenever a preference value is changed.
public onChange ( string $scope, string $pref )
$scope string Scope specifier.
$pref string The preference name.

remove() abstract public method

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.

store() abstract public method

Stores changed preferences in the storage backend.
abstract public store ( Horde_Prefs_Scope $scope_ob )
$scope_ob Horde_Prefs_Scope The scope object.

Property Details

$_params protected_oe property

'user' is always available as an entry.
protected string $_params
return string