PHP Class Horde_Prefs_Storage_File, horde

Author: Thomas Jarosch ([email protected])

Author: Michael Slusarz ([email protected])

Inheritance: extends Horde_Prefs_Storage_Base

Protected Properties

Property	Type	Description
$_fileCache	array	Cached unserialized data of all scopes.
$_fullpath	string	Full path to the current preference file.

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.
updateFileFormat ( )	Updates format of file.

Method	Description
_loadFileCache ( ) : boolean	Load the preferences from the files.

Constructor.

public __construct ( string $user, array $params = [] )
$user	string	The username.
$params	array	Configuration parameters: 'directory' - (string) [REQUIRED] Preference storage directory.

Load the preferences from the files.

protected _loadFileCache ( ) : boolean
return	boolean	True on success.

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.

Updates format of file.

public updateFileFormat ( )

Cached unserialized data of all scopes.

protected array $_fileCache
return	array

Full path to the current preference file.

protected string $_fullpath
return	string