Class Horde_Prefs_Storage_Base

Storage driver for the preferences system.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Direct known subclasses

Horde_Prefs_Storage_File, Horde_Prefs_Storage_Imsp, Horde_Prefs_Storage_KolabImap, Horde_Prefs_Storage_Ldap, Horde_Prefs_Storage_Null, Horde_Prefs_Storage_Sql

Abstract
Package: Prefs
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Prefs/Storage/Base.php

Methods summary
`public`	# `__construct( string $user, array $params = array() )` Constructor. Constructor. Parameters `$user` The username. `$params` Additional configuration parameters.
`public array`	# `getParams( )` Get the list of driver parameters. Get the list of driver parameters. Returns `array` Driver parameters.
`abstract public Horde_Prefs_Scope`	# `get( Horde_Prefs_Scope $scope_ob )` Retrieves the requested preferences scope from the storage backend. Retrieves the requested preferences scope from the storage backend. Parameters `$scope_ob` The scope object. Returns `Horde_Prefs_Scope` The modified scope object. Throws `Horde_Prefs_Exception`
`abstract public`	# `store( Horde_Prefs_Scope $scope_ob )` Stores changed preferences in the storage backend. Stores changed preferences in the storage backend. Parameters `$scope_ob` The scope object. Throws `Horde_Prefs_Exception`
`public`	# `onChange( string $scope, string $pref )` Called whenever a preference value is changed. Called whenever a preference value is changed. Parameters `$scope` Scope specifier. `$pref` The preference name.
`abstract public`	# `remove( string $scope = null, string $pref = null )` Removes preferences from the backend. Removes preferences from the backend. Parameters `$scope` <p>The scope of the prefs to clear. If null, clears all scopes.</p> `$pref` <p>The pref to clear. If null, clears the entire scope.</p> Throws `Horde_Prefs_Exception`
`public array`	# `listScopes( )` Lists all available scopes. Lists all available scopes. Returns `array` The list of scopes stored in the backend. Since Horde_Prefs 1.1.0

Packages

Classes

Class Horde_Prefs_Storage_Base

Direct known subclasses

Parameters

Returns

Parameters

Returns

Throws

Parameters

Throws

Parameters

Parameters

Throws

Returns

Since