Class Prefs_Credentials

Description

Class for handling a list of credentials stored in a user's preferences.

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

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


	
			
Variable Summary
 string $app
Method Summary
 Prefs_Credentials Prefs_Credentials ()
 array getCredentials ()
 mixed getValue (string $pref)
 void showUI ()
 Prefs_Credentials singleton (string $app)
Variables
string $app (line 24)

The Horde application currently processed.

array $_credentials = array() (line 31)

A list of preference field names and their values.

Methods
Constructor Prefs_Credentials (line 36)

Constructor.

Prefs_Credentials Prefs_Credentials ()
getCredentials (line 73)

Returns a list of available credentials collected from all Horde applications.

  • return: A list of Horde applications and their credentials.
array getCredentials ()
getValue (line 138)

Returns the value of a credential for the currently processed application.

  • return: The credential's value, either from the user's preferences, or from the default value, or null.
  • see: Prefs::getValue()
mixed getValue (string $pref)
  • string $pref: A credential name.
showUI (line 102)

Displays the preference interface for setting all available credentials.

void showUI ()
singleton (line 57)

Returns a single instance of the Prefs_Credentials class, and sets the curently processed application.

  • return: A Prefs_Credentials instance.
Prefs_Credentials singleton (string $app)
  • string $app: The current application.

Documentation generated on Sun, 30 Jan 2011 05:16:07 +0000 by phpDocumentor 1.4.3