PHP 클래스 Horde_Prefs_Storage_KolabImap, horde

저자: Gunnar Wrobel ([email protected])
상속: extends Horde_Prefs_Storage_Base
파일 보기 프로젝트 열기: horde/horde

보호된 프로퍼티들

프로퍼티 타입 설명
$_folder string Name of the preferences default folder
$_kolab Horde_Kolab_Storage Handle for the current Kolab connection.
$_logger Horde_Log_Logger Log handler.

공개 메소드들

메소드 설명
__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.

보호된 메소드들

메소드 설명
_getStorage ( boolean $create_missing = false ) : Horde_Kolab_Storage_Data Opens a connection to the Kolab server.

비공개 메소드들

메소드 설명
_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.

메소드 상세

__construct() 공개 메소드

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')

_getStorage() 보호된 메소드

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.
리턴 Horde_Kolab_Storage_Data The storage backend.

get() 공개 메소드

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.
리턴 Horde_Prefs_Scope The modified scope object.

listScopes() 공개 메소드

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

remove() 공개 메소드

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.

store() 공개 메소드

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

프로퍼티 상세

$_folder 보호되어 있는 프로퍼티

Name of the preferences default folder
protected string $_folder
리턴 string

$_kolab 보호되어 있는 프로퍼티

Handle for the current Kolab connection.
protected Horde_Kolab_Storage $_kolab
리턴 Horde_Kolab_Storage

$_logger 보호되어 있는 프로퍼티

Log handler.
protected Horde_Log_Logger $_logger
리턴 Horde_Log_Logger