[Horde_Prefs] element index

Package indexes

All elements
a c d f g h i k l p r s t u v _
_
top
Variable $_cache
Prefs::$_cache in Prefs.php
Array to cache in. Usually a reference to an array in $_SESSION, but could be overridden by a subclass for testing or other users.
Variable $_caching
Prefs::$_caching in Prefs.php
Boolean indicating whether preference caching should be used.
Variable $_connected
Boolean indicating whether or not we're connected to the IMSP server.
Variable $_connected
Boolean indicating whether or not we're connected to the LDAP server.
Variable $_connected
Boolean indicating whether or not we're connected to the SQL server.
Variable $_connection
Handle for the current Kolab connection.
Variable $_connection
Handle for the current LDAP connection.
Variable $_credentials
A list of preference field names and their values.
Variable $_db
Prefs_sql::$_db in sql.php
Handle for the current database connection.
Variable $_default
Identity::$_default in Identity.php
A pointer to the user's standard identity.
Variable $_dirname
Directory to store the preferences
Variable $_dn
Prefs_ldap::$_dn in ldap.php
String holding the user's DN.
Variable $_file_cache
Cached unserialized data of all scopes
Variable $_fullpath
Full path to the current preference file
Variable $_hooks
Prefs::$_hooks in Prefs.php
Hash holding preferences with hook functions defined.
Variable $_identities
Identity::$_identities in Identity.php
Array containing all the user's identities.
Variable $_imsp
Prefs_imsp::$_imsp in imsp.php
Handle for the IMSP server connection.
Variable $_params
Hash containing connection parameters.
Variable $_params
Holds the driver specific parameters.
Variable $_params
Hash containing connection parameters.
Variable $_password
String holding the user's password.
Variable $_password
User password.
Variable $_prefs
Identity::$_prefs in Identity.php
Reference to the prefs object that this Identity points to.
Variable $_prefs
Prefs::$_prefs in Prefs.php
Hash holding the current set of preferences. Each preference is itself a hash, so this will ultimately be multi-dimensional.
Variable $_properties
Identity::$_properties in Identity.php
Array containing all of the properties in this identity.
Variable $_scope
Prefs::$_scope in Prefs.php
String containing the name of the current scope. This is used to differentiate between sets of preferences (multiple applications can have a "sortby" preference, for example). By default, all preferences belong to the "global" (Horde) scope.
Variable $_scopes
Prefs::$_scopes in Prefs.php
Array of loaded scopes. In order to only load what we need, and
Variable $_share
Prefs_kolab_imap::$_share in kolab_imap.php
ID of the config default share
Variable $_user
Identity::$_user in Identity.php
The user whose identities these are.
Variable $_user
Prefs::$_user in Prefs.php
String containing the current username. This indicates the owner of the preferences.
Variable $_version
Current version number of the data format
Variable $_write_db
Handle for the current database connection, used for writing. Defaults to the same handle as $_db if a separate write database is not configured.
Method _cacheLookup
Tries to find the requested preferences in the cache. If they exist, update the $_scopes hash with the cached values.
Method _cacheUpdate
Updates the session-based preferences cache (if available).
Method _dirtyPrefs
Return all "dirty" preferences across all scopes.
Method _getPref
Retrieves the requested preference from the user's config folder.
Method _getPreferenceScope
Returns the scope of the given preference.
Method _loadScope
Prefs::_loadScope() in Prefs.php
Load a specific preference scope.
Constant _PREF_DEFAULT
_PREF_DEFAULT in Prefs.php
Preference value is the application default.
Constant _PREF_DIRTY
_PREF_DIRTY in Prefs.php
Preference value has been changed.
Constant _PREF_LOCKED
_PREF_LOCKED in Prefs.php
Preference is administratively locked.
Constant _PREF_SHARED
_PREF_SHARED in Prefs.php
Preference is shared amongst applications.
Method _read_cache
Read data from disc
Method _retrieve
Retrieves the requested set of preferences from the current session.
Method _retrieve
Retrieves the requested set of preferences from the current session.
Method _retrieve
Retrieves the requested set of preferences from the IMSP server.
Method _retrieve
Retrieves the requested set of preferences from the user's config folder.
Method _retrieve
Retrieves the requested set of preferences from the user's database entry.
Method _retrieve
Retrieves the requested set of preferences from the user's LDAP entry.
Method _setValue
Prefs::_setValue() in Prefs.php
Sets the given preferences ($pref) to the specified value ($val), whether or not the preference is user-modifiable, unset the default bit, and set the dirty bit.
Method _write_cache
Write data to disc
Method __get
Prefs::__get() in Prefs.php
Method __set
Prefs::__set() in Prefs.php
a
top
Variable $app
Prefs_Credentials::$app in Credentials.php
The Horde application currently processed.
Method add
Identity::add() in Identity.php
Adds a new identity to the array of identities.
Method add
Prefs_CategoryManager::add() in CategoryManager.php
Add a new category.
c
top
Method cleanup
Perform cleanup operations.
Method cleanup
Prefs::cleanup() in Prefs.php
This function provides common cleanup functions for all of the driver implementations.
Method clear
Clears all preferences from the backend.
Method clear
Clears all preferences from the LDAP backend.
Method clear
Prefs::clear() in Prefs.php
Clears all preferences from the backend.
Method clear
Prefs_kolab_imap::clear() in kolab_imap.php
Clears all preferences from the kolab_imap backend.
Method colors
Prefs_CategoryManager::colors() in CategoryManager.php
Returns the color for each of the user's categories.
Method confirmIdentity
Checks whether an identity confirmation is valid, and adds the validated identity.
Method convertFromDriver
Converts a value from the driver's charset to the specified charset.
Method convertFromDriver
Converts a value from the driver's charset to the specified charset.
Method convertToDriver
Converts a value from the specified charset to the driver's charset.
Method convertToDriver
Converts a value from the specified charset to the driver's charset.
Page CategoryManager.php
CategoryManager.php in CategoryManager.php
Page Credentials.php
Credentials.php in Credentials.php
d
top
Method delete
Identity::delete() in Identity.php
Removes an identity from the array of identities.
f
top
Method factory
Prefs::factory() in Prefs.php
Attempts to return a concrete Prefs instance based on $driver.
Method factory
Identity::factory() in Identity.php
Attempts to return a concrete Identity instance based on $type.
Method fgColors
Prefs_CategoryManager::fgColors() in CategoryManager.php
Returns the foreground color for each of the user's categories.
Page file.php
file.php in file.php
g
top
Method generateHeader
Generates the the full header of a preference screen including menu and navigation bars.
Method generateNavigationCell
Generate the content of the title bar navigation cell (previous | next option group).
Method generateUI
Generate the UI for the preferences interface, either for a specific group, or the group selection interface.
Method get
Identity::get() in Identity.php
Returns a complete identity hash.
Method get
Prefs_CategoryManager::get() in CategoryManager.php
Get all categories.
Method getAll
Identity::getAll() in Identity.php
Returns an array with the specified property from all existing identities.
Method getCharset
Returns the charset used by the concrete preference backend.
Method getCharset
Prefs::getCharset() in Prefs.php
Returns the charset used by the concrete preference backend.
Method getCredentials
Returns a list of available credentials collected from all Horde applications.
Method getDefault
Prefs::getDefault() in Prefs.php
Returns the default value of the given preference.
Method getDefault
Identity::getDefault() in Identity.php
Returns a pointer to the current default identity.
Method getDefaultApp
Get the default application to show preferences for. Defaults to 'horde'.
Method getDefaultFromAddress
Generates the from address to use for the default identity.
Method getJavaScript
Method getScope
Prefs::getScope() in Prefs.php
Get the current scope
Method getSelect
Prefs_CategoryManager::getSelect() in CategoryManager.php
Method getUser
Prefs::getUser() in Prefs.php
Return the user who owns these preferences.
Method getValue
Prefs::getValue() in Prefs.php
Returns the value of the requested preference.
Method getValue
Returns the value of a credential for the currently processed application.
Method getValue
Identity::getValue() in Identity.php
Returns a property from one of the identities. If this value doesn't exist or is locked, the property is retrieved from the prefs backend.
Method groupIsEditable
Determine whether or not a preferences group is editable.
h
top
Method handleForm
Handle a preferences form submission if there is one, updating any preferences which have been changed.
Method hasValue
Identity::hasValue() in Identity.php
Returns true if the given address belongs to one of the identities.
i
top
Class Identity
Identity in Identity.php
This class provides an interface to all identities a user might have. Its methods take care of any site-specific restrictions configured in prefs.php and conf.php.
Method Identity
Identity::Identity() in Identity.php
Reads all the user's identities from the prefs object or builds a new identity from the standard values given in prefs.php.
Method init
Identity::init() in Identity.php
Creates a default identity if none exists yet and sets the preferences up if the identities are locked.
Method isDefault
Prefs::isDefault() in Prefs.php
Determines if the current preference value is the default value from prefs.php or a user defined value
Method isDirty
Prefs::isDirty() in Prefs.php
Returns the state of the "dirty" bit for the given preference.
Method isLocked
Prefs::isLocked() in Prefs.php
Returns the state of the "locked" bit for the given preference.
Method isLocked
Identity::isLocked() in Identity.php
Returns true if all properties are locked and therefore nothing in the identities can be changed.
Method isShared
Prefs::isShared() in Prefs.php
Returns the state of the "shared" bit for the given preference.
Page Identity.php
Identity.php in Identity.php
Page imsp.php
imsp.php in imsp.php
k
top
Page kolab.php
kolab.php in kolab.php
Page kolab_imap.php
kolab_imap.php in kolab_imap.php
l
top
Page ldap.php
ldap.php in ldap.php
p
top
Method Prefs
Prefs::Prefs() in Prefs.php
Default constructor (must be called from each extending class in their constructors via parent::Prefs()).
Class Prefs
Prefs in Prefs.php
The Prefs:: class provides a common abstracted interface into the various preferences storage mediums. It also includes all of the functions for retrieving, storing, and checking preference values.
Page Prefs.php
Prefs.php in Prefs.php
Class Prefs_CategoryManager
Prefs_CategoryManager in CategoryManager.php
Class for handling a list of categories stored in a user's preferences.
Method Prefs_Credentials
Constructor.
Class Prefs_Credentials
Prefs_Credentials in Credentials.php
Class for handling a list of credentials stored in a user's preferences.
Class Prefs_file
Prefs_file in file.php
Preferences storage implementation using files in a directory
Method Prefs_file
Constructs a new file preferences object.
Class Prefs_imsp
Prefs_imsp in imsp.php
Preference storage implementation for an IMSP server.
Method Prefs_imsp
Constructor function.
Class Prefs_kolab
Prefs_kolab in kolab.php
Kolab implementation of the Horde preference system. Derives from the Prefs_ldap LDAP authentication object, and simply provides parameters to it based on the global Kolab configuration.
Method Prefs_kolab
Constructs a new Kolab preferences object.
Method Prefs_kolab_imap
Constructs a new kolab_imap preferences object.
Class Prefs_kolab_imap
Prefs_kolab_imap in kolab_imap.php
Preferences storage implementation for a Kolab IMAP server
Method Prefs_ldap
Constructs a new LDAP preferences object.
Class Prefs_ldap
Prefs_ldap in ldap.php
Preferences storage implementation for PHP's LDAP extention.
Method Prefs_session
Constructs a new session preferences object.
Class Prefs_session
Prefs_session in session.php
Preferences storage implementation for PHP's session implementation.
Class Prefs_sql
Prefs_sql in sql.php
Preferences storage implementation for PHP's PEAR database abstraction layer.
Method Prefs_sql
Constructs a new SQL preferences object.
Class Prefs_UI
Prefs_UI in UI.php
Class for auto-generating the preferences user interface and processing the forms.
r
top
Method remove
Prefs::remove() in Prefs.php
Removes a preference entry from the $prefs hash.
Method remove
Prefs_CategoryManager::remove() in CategoryManager.php
Delete a category.
Method retrieve
Prefs::retrieve() in Prefs.php
Retrieves preferences for the current scope + the 'horde' scope.
s
top
Page session.php
session.php in session.php
Page sql.php
sql.php in sql.php
Method save
Identity::save() in Identity.php
Saves all identities in the prefs backend.
Method setColor
Prefs_CategoryManager::setColor() in CategoryManager.php
Method setColors
Prefs_CategoryManager::setColors() in CategoryManager.php
Method setDefault
Identity::setDefault() in Identity.php
Sets the current default identity.
Method setDefault
Prefs::setDefault() in Prefs.php
Modifies the "default" bit for the given preference.
Method setDirty
Prefs::setDirty() in Prefs.php
Modifies the "dirty" bit for the given preference.
Method setLocked
Prefs::setLocked() in Prefs.php
Modifies the "locked" bit for the given preference.
Method setScope
Prefs::setScope() in Prefs.php
Change scope without explicitly retrieving preferences
Method setShared
Prefs::setShared() in Prefs.php
Modifies the "shared" bit for the given preference.
Method setValue
Identity::setValue() in Identity.php
Sets a property with a specified value.
Method setValue
Prefs::setValue() in Prefs.php
Sets the given preferences ($pref) to the specified value ($val), if the preference is modifiable.
Method showUI
Prefs_Credentials::showUI() in Credentials.php
Displays the preference interface for setting all available credentials.
Method singleton
Identity::singleton() in Identity.php
Attempts to return a reference to a concrete Identity instance based on $type. It will only create a new instance if no Identity instance with the same parameters currently exists.
Method singleton
Prefs::singleton() in Prefs.php
Attempts to return a reference to a concrete Prefs instance based on $driver. It will only create a new instance if no Prefs instance with the same parameters currently exists.
Method singleton
Returns a single instance of the Prefs_Credentials class, and sets the curently processed application.
Method store
Prefs_session::store() in session.php
Stores preferences in the current session.
Method store
Stores preferences to the SQL server.
Method store
Stores preferences to the LDAP server.
Method store
Stores preferences in the current session.
Method store
Stores all dirty prefs to IMSP server.
Method store
Prefs_kolab_imap::store() in kolab_imap.php
Stores preferences to the Kolab server.
Method store
Prefs::store() in Prefs.php
This function will be run at the end of every request as a shutdown
t
top
Method transformV1V2
Transforms the broken version 1 format into version 2.
u
top
Page UI.php
UI.php in UI.php
v
top
Method verify
Identity::verify() in Identity.php
Verifies and sanitizes all identity properties.
Method verifyIdentity
Sends a message to an email address supposed to be added to the identity.
a c d f g h i k l p r s t u v _