Class Prefs_imsp

Description

Preference storage implementation for an IMSP server.

$Horde: framework/Prefs/Prefs/imsp.php,v 1.1.10.15 2009/01/06 15:23:31 jan Exp $

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

Located in /Prefs/Prefs/imsp.php (line 24)

Prefs
   |
   --Prefs_imsp
Variable Summary
Method Summary
 Prefs_imsp Prefs_imsp (string $user, [string $password = ''], [string $scope = ''], [array $params = null], [boolean $caching = true])
 void store ()
 mixed _retrieve ($scope $scope)
Variables
boolean $_connected = false (line 45)

Boolean indicating whether or not we're connected to the IMSP server.

Net_IMSP $_imsp (line 31)

Handle for the IMSP server connection.

array $_params = array() (line 52)

Holds the driver specific parameters.

string $_password (line 38)

User password.

Inherited Variables

Inherited from Prefs

Prefs::$_cache
Prefs::$_caching
Prefs::$_hooks
Prefs::$_prefs
Prefs::$_scope
Prefs::$_scopes
Prefs::$_user
Methods
Constructor Prefs_imsp (line 65)

Constructor function.

$params must contain: 'auth_method', 'server', 'port'

Prefs_imsp Prefs_imsp (string $user, [string $password = ''], [string $scope = ''], [array $params = null], [boolean $caching = true])
  • string $user: Username of current user.
  • string $password: Password for current user.
  • string $scope: The scope for these preferences.
  • array $params: The parameters needed for this object.
  • boolean $caching: Are we using session cache?
store (line 121)

Stores all dirty prefs to IMSP server.

void store ()

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

Retrieves the requested set of preferences from the IMSP server.

  • 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:30 +0000 by phpDocumentor 1.4.3