Class Horde_Core_Prefs_Ui

Class for generating/processing the preferences UI.

See Horde_Registry_Application:: for a summary of the API callbacks that are available.

Session variables set (stored in 'horde_prefs'): 'advanced' - (boolean) If true, display advanced prefs.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: Core
Category: Horde
License: LGPL 2.1
Author: Chuck Hagenbuch chuck@horde.org
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Core/Prefs/Ui.php

Methods summary
`public`	# `__construct( Horde_Variables $vars )` Constructor. Constructor. Parameters `$vars` Form variables.
`public boolean`	# `groupIsEditable( string $group )` Determine whether or not a preferences group is editable. Determine whether or not a preferences group is editable. Parameters `$group` The preferences group to check. Returns `boolean` Whether or not the group is editable.
`public array`	# `getChangeablePrefs( string $group = null )` Returns the list of changeable prefs for a group. Returns the list of changeable prefs for a group. Parameters `$group` The preferences group to check. Returns `array` The list of changeable prefs.
`public boolean`	# `hasAdvancedPrefs( )` Returns whether advanced preferences exist in the current application. Returns whether advanced preferences exist in the current application. Returns `boolean` True if at least one of the preferences is an advanced preference.
`public`	# `handleForm( )` Handle a preferences form submission if there is one, updating any preferences which have been changed. Handle a preferences form submission if there is one, updating any preferences which have been changed.
`public Horde_Url`	# `selfUrl( array $options = array() )` Returns a self URL to the current page. Returns a self URL to the current page. Parameters `$options` Additional options: <pre><span class="php-quote">'special'</span> - (boolean) <span class="php-keyword1">If</span> set, will trigger special action update processing when the URL is loaded. <span class="php-quote">'token'</span> - (boolean) <span class="php-keyword1">If</span> set, includes the form token in the URL.</pre> Returns `Horde_Url` The URL object.
`public`	# `generateUI( )` Generate the UI for the preferences interface, either for a specific group, or the group selection interface. Generate the UI for the preferences interface, either for a specific group, or the group selection interface.
`public string`	# `getDefaultApp( )` Get the default application to show preferences for. Defaults to 'horde'. Get the default application to show preferences for. Defaults to 'horde'. Returns `string` The default application.

Properties summary
`public array`	`$prefGroups` Preferences groups. Preferences groups.	# `array()`
`public array`	`$prefs` Preferences. Preferences.	# `array()`
`public array`	`$override` Data overrides (for 'enum' and 'multienum' types). Data overrides (for 'enum' and 'multienum' types).	# `array()`
`public array`	`$suppress` Suppressed preference entries. Suppressed preference entries.	# `array()`
`public array`	`$suppressGroups` Suppressed prefGroup entries. Suppressed prefGroup entries.	# `array()`
`public string`	`$app` Current application. Current application.	#
`public string`	`$group` Current preferences group. Current preferences group.	#
`public Horde_Variables`	`$vars` Form variables for this page load. Form variables for this page load.	#
`public boolean`	`$nobuttons` If set, suppresses display of the buttons. If set, suppresses display of the buttons.	# `false`

Packages

Classes

Exceptions

Class Horde_Core_Prefs_Ui

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns