PHP Class Horde_Prefs_Storage_KolabImap, horde

Author: Gunnar Wrobel ([email protected])

Inheritance: extends Horde_Prefs_Storage_Base

Protected Properties

Property	Type	Description
$_folder	string	Name of the preferences default folder
$_kolab	Horde_Kolab_Storage	Handle for the current Kolab connection.
$_logger	Horde_Log_Logger	Log handler.

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.
listScopes ( ) : array	Lists all available scopes.
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	Description
_getStorage ( boolean $create_missing = false ) : Horde_Kolab_Storage_Data	Opens a connection to the Kolab server.

Method	Description
_arrayToPref ( array $pref ) : array	Convert a key => value list of preferences to the Kolab preferences.
_logMissingScope ( Exception $e, string $scope ) : null	Log the missing scope.
_logMissingStorage ( Exception $e ) : null	Log the missing backend.
_prefToArray ( array $pref ) : array	Convert Kolab preferences data to an array.

Constructor.

public __construct ( string $user, array $params = [] )
$user	string	The username.
$params	array	Configuration parameters. 'kolab' - (Horde_Kolab_Storage) [REQUIRED] The storage backend. 'folder' - (string) The default name of the preferences folder. DEFAULT: _('Preferences')

Opens a connection to the Kolab server.

protected _getStorage ( boolean $create_missing = false ) : Horde_Kolab_Storage_Data
$create_missing	boolean	Create a preferences folder if it is missing.
return	Horde_Kolab_Storage_Data	The storage backend.

Retrieves the requested preferences scope from the storage backend.

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.

Lists all available scopes.

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

Removes preferences from the backend.

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.

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

Name of the preferences default folder

protected string $_folder
return	string

Handle for the current Kolab connection.

protected Horde_Kolab_Storage $_kolab
return	Horde_Kolab_Storage

Log handler.

protected Horde_Log_Logger $_logger
return	Horde_Log_Logger