Class Prefs_UI

Description

Class for auto-generating the preferences user interface and processing the forms.

$Horde: framework/Prefs/Prefs/UI.php,v 1.63.2.26 2010-09-27 10:10:05 jan Exp $

Copyright 2001-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/UI.php (line 17)


	
			
Method Summary
 void generateHeader ([string $group = null], [boolean $chunk = false])
 void generateNavigationCell (string $group)
 void generateUI ([string $group = null], [boolean $chunk = false])
 void getDefaultApp ()
 boolean groupIsEditable (string $group)
 boolean handleForm ( &$group,  &$save, string $group, object $save)
Methods
generateHeader (line 284)

Generates the the full header of a preference screen including menu and navigation bars.

void generateHeader ([string $group = null], [boolean $chunk = false])
  • string $group: The group to generate the header for.
  • boolean $chunk: Whether to only return the body part (since Horde 3.2.).
generateNavigationCell (line 352)

Generate the content of the title bar navigation cell (previous | next option group).

void generateNavigationCell (string $group)
  • string $group: Current option group.
generateUI (line 208)

Generate the UI for the preferences interface, either for a specific group, or the group selection interface.

void generateUI ([string $group = null], [boolean $chunk = false])
  • string $group: The group to generate the UI for.
  • boolean $chunk: Whether to only return the body part (since Horde 3.2.).
getDefaultApp (line 407)

Get the default application to show preferences for. Defaults to 'horde'.

void getDefaultApp ()
groupIsEditable (line 26)

Determine whether or not a preferences group is editable.

  • return: Whether or not the group is editable.
boolean groupIsEditable (string $group)
  • string $group: The preferences group to check.
handleForm (line 61)

Handle a preferences form submission if there is one, updating any preferences which have been changed.

  • return: Whether preferences have been updated.
boolean handleForm ( &$group,  &$save, string $group, object $save)
  • string $group: The preferences group that was edited.
  • object $save: The object where the changed values are saved. Must implement setValue(string, string).
  • &$group
  • &$save

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