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_Cache_Base

Cache driver for the preferences system.

Copyright 2010-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.

Direct known subclasses

Horde_Prefs_Cache_Null, Horde_Prefs_Cache_Session
Abstract
Package: Prefs
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Prefs/Cache/Base.php
Methods summary
public
# __construct( string $user, array $params = array() )

Constructor.

Constructor.

Parameters

$user
The username.
$params
Additional configuration parameters.
abstract public mixed
# get( string $scope )

Retrieves the requested preferences scope from the cache backend.

Retrieves the requested preferences scope from the cache backend.

Parameters

$scope
Scope specifier.

Returns

mixed

Returns false if no data is available, otherwise the Horde_Prefs_Scope object.

Throws

Horde_Prefs_Exception
abstract public
# store( Horde_Prefs_Scope $scope_ob )

Stores preferences in the cache backend.

Stores preferences in the cache backend.

Parameters

$scope_ob
The scope object to store.

Throws

Horde_Prefs_Exception
abstract public
# remove( string $scope = null )

Removes preferences from the cache.

Removes preferences from the cache.

Parameters

$scope
<p>The scope to remove. If null, clears entire cache.</p>

Throws

Horde_Prefs_Exception
API documentation generated by ApiGen