Class Prefs_kolab_imap

Description

Preferences storage implementation for a Kolab IMAP server

Copyright 2007-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

  • author: Gunnar Wrobel <p@rdus.de>
  • since: Horde 3.2

Located in /Prefs/Prefs/kolab_imap.php (line 27)

Prefs
   |
   --Prefs_kolab_imap
Variable Summary
Method Summary
 Prefs_kolab_imap Prefs_kolab_imap (string $user, [string $password = ''], [string $scope = ''], [array $params = null], [boolean $caching = true])
 void clear ()
 void store ()
 array &_getPref ($scope $scope)
 mixed _retrieve ($scope $scope)
Variables
Kolab $_connection (line 41)

Handle for the current Kolab connection.

string $_share (line 34)

ID of the config default share

Inherited Variables

Inherited from Prefs

Prefs::$_cache
Prefs::$_caching
Prefs::$_hooks
Prefs::$_prefs
Prefs::$_scope
Prefs::$_scopes
Prefs::$_user
Methods
Constructor Prefs_kolab_imap (line 54)

Constructs a new kolab_imap preferences object.

Prefs_kolab_imap Prefs_kolab_imap (string $user, [string $password = ''], [string $scope = ''], [array $params = null], [boolean $caching = true])
  • string $user: The user who owns these preferences.
  • string $password: The password associated with $user. (Unused)
  • string $scope: The current preferences scope.
  • array $params: A hash containing connection parameters. (Unused)
  • boolean $caching: Should caching be used?
clear (line 245)

Clears all preferences from the kolab_imap backend.

void clear ()

Redefinition of:
Prefs::clear()
Clears all preferences from the backend.
store (line 177)

Stores preferences to the Kolab server.

void store ()

Redefinition of:
Prefs::store()
This function will be run at the end of every request as a shutdown
_getPref (line 153)

Retrieves the requested preference from the user's config folder.

  • return: The preference value or a PEAR_Error object on failure.
array &_getPref ($scope $scope)
  • $scope $scope: Scope specifier.
_retrieve (line 103)

Retrieves the requested set of preferences from the user's config folder.

  • return: True on success or a PEAR_Error object on failure.
mixed _retrieve ($scope $scope)
  • $scope $scope: Scope specifier.

Inherited Methods

Inherited From Prefs

 Prefs::Prefs()
 Prefs::cleanup()
 Prefs::clear()
 Prefs::convertFromDriver()
 Prefs::convertToDriver()
 Prefs::factory()
 Prefs::getCharset()
 Prefs::getDefault()
 Prefs::getScope()
 Prefs::getUser()
 Prefs::getValue()
 Prefs::isDefault()
 Prefs::isDirty()
 Prefs::isLocked()
 Prefs::isShared()
 Prefs::remove()
 Prefs::retrieve()
 Prefs::setDefault()
 Prefs::setDirty()
 Prefs::setLocked()
 Prefs::setScope()
 Prefs::setShared()
 Prefs::setValue()
 Prefs::singleton()
 Prefs::store()
 Prefs::_cacheLookup()
 Prefs::_cacheUpdate()
 Prefs::_dirtyPrefs()
 Prefs::_getPreferenceScope()
 Prefs::_loadScope()
 Prefs::_setValue()
 Prefs::__get()
 Prefs::__set()

Documentation generated on Sun, 30 Jan 2011 05:18:59 +0000 by phpDocumentor 1.4.3