Overview

Packages

  • Prefs

Classes

  • Horde_Prefs
  • Horde_Prefs_Cache_Base
  • Horde_Prefs_Cache_Null
  • Horde_Prefs_Cache_Session
  • Horde_Prefs_CategoryManager
  • Horde_Prefs_Exception
  • Horde_Prefs_Identity
  • Horde_Prefs_Scope
  • Horde_Prefs_Storage_Base
  • Horde_Prefs_Storage_File
  • Horde_Prefs_Storage_Imsp
  • Horde_Prefs_Storage_KolabImap
  • Horde_Prefs_Storage_Ldap
  • Horde_Prefs_Storage_Null
  • Horde_Prefs_Storage_Sql
  • Horde_Prefs_Translation
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Prefs_Storage_File

Preferences storage implementation using files in a directory

Copyright 2008-2012 Horde LLC (http://www.horde.org/)

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

Horde_Prefs_Storage_Base
Extended by Horde_Prefs_Storage_File
Package: Prefs
Category: Horde
Author: Thomas Jarosch thomas.jarosch@intra2net.com
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Prefs/Storage/File.php
Methods summary
public
# __construct( string $user, array $params = array() )

Constructor.

Constructor.

Parameters

$user
The username.
$params
Configuration parameters: <span class="php-quote">'directory'</span> - (string) [REQUIRED] Preference storage directory.

Throws

InvalidArgumentException

Overrides

Horde_Prefs_Storage_Base::__construct()
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
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
# 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_Db_Exception
public
# updateFileFormat( )

Updates format of file.

Updates format of file.

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

Overrides

Horde_Prefs_Storage_Base::listScopes()
Methods inherited from Horde_Prefs_Storage_Base
getParams(), onChange()
Constants summary
integer VERSION
# 2
API documentation generated by ApiGen