Class Prefs_session

Description

Preferences storage implementation for PHP's session implementation.

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

Copyright 1999-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/session.php (line 16)

Prefs
   |
   --Prefs_session
Method Summary
 Prefs_session Prefs_session (string $user, [string $password = ''], [string $scope = ''], [array $params = null], [boolean $caching = true])
 void cleanup ([boolean $all = false])
 mixed store ()
 mixed _retrieve ($scope $scope)
Variables
Methods
Constructor Prefs_session (line 29)

Constructs a new session preferences object.

Prefs_session Prefs_session (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?
cleanup (line 82)

Perform cleanup operations.

void cleanup ([boolean $all = false])
  • boolean $all: Cleanup all Horde preferences.

Redefinition of:
Prefs::cleanup()
This function provides common cleanup functions for all of the driver implementations.
store (line 58)

Stores preferences in the current session.

  • return: True on success or a PEAR_Error object on failure.
mixed store ()

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

Retrieves the requested set of preferences from the current session.

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