PHP Класс Horde_Core_Prefs_Ui, horde

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.
Автор: Chuck Hagenbuch ([email protected])
Автор: Michael Slusarz ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$app string Current application.
$group string Current preferences group.
$nobuttons boolean If set, suppresses display of the buttons.
$prefGroups array Preferences groups.
$prefs array Preferences.
$suppress array Suppressed preference entries.
$suppressGroups array Suppressed prefGroup entries.
$vars Horde_Variables Form variables for this page load.

Защищенные свойства (Protected)

Свойство Тип Описание
$_errors array List of update errors.

Открытые методы

Метод Описание
__construct ( Horde_Variables $vars ) Constructor.
generateUI ( ) Generate the UI for the preferences interface, either for a specific group, or the group selection interface.
getChangeablePrefs ( string $group = null ) : array Returns the list of changeable prefs for a group.
getDefaultApp ( ) : string Get the default application to show preferences for. Defaults to 'horde'.
groupIsEditable ( string $group ) : boolean Determine whether or not a preferences group is editable.
handleForm ( ) Handle a preferences form submission if there is one, updating any preferences which have been changed.
hasAdvancedPrefs ( ) : boolean Returns whether advanced preferences exist in the current application.
selfUrl ( array $options = [] ) : Horde_Url Returns a self URL to the current page.

Защищенные методы

Метод Описание
_addHordeIdentitiesPrefs ( array $pref_list ) : array Adds Horde base identities prefs to preference list.
_generateEntry ( string $member, mixed $val ) : array Generates an entry hash for an identity's preference value.
_getPrefGroups ( ) : array Get the list of viewable preference groups, filtering out suppressed groups and groups with no settable prefs.
_handleForm ( $preflist, $save ) * Handle a preferences form submission if there is one, updating any preferences which have been changed.
_identitiesUpdate ( ) Update identities prefs.
_identityHeader ( array $members ) : string Output the identities page header entries (default identity, identity selection, and identity deletion).
_loadPrefs ( string $app, boolean $data = false ) Parses/loads preferences configuration.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( Horde_Variables $vars )
$vars Horde_Variables Form variables.

_addHordeIdentitiesPrefs() защищенный Метод

Adds Horde base identities prefs to preference list.
protected _addHordeIdentitiesPrefs ( array $pref_list ) : array
$pref_list array Preference list.
Результат array The preference list with the Horde preferences added, if needed. These prefs are also added to $this->prefs.

_generateEntry() защищенный Метод

Generates an entry hash for an identity's preference value.
protected _generateEntry ( string $member, mixed $val ) : array
$member string A preference name.
$val mixed A preference value.
Результат array An array with preference name, type, and value.

_getPrefGroups() защищенный Метод

Get the list of viewable preference groups, filtering out suppressed groups and groups with no settable prefs.
protected _getPrefGroups ( ) : array
Результат array The filtered prefGroups array.

_handleForm() защищенный Метод

* Handle a preferences form submission if there is one, updating any preferences which have been changed.
protected _handleForm ( $preflist, $save )
$preflist The list of preferences to process.
$save The object to save preferences values to.

_identitiesUpdate() защищенный Метод

Update identities prefs.
protected _identitiesUpdate ( )

_identityHeader() защищенный Метод

Output the identities page header entries (default identity, identity selection, and identity deletion).
protected _identityHeader ( array $members ) : string
$members array The list of prefs to display on this page.
Результат string HTML output.

_loadPrefs() защищенный Метод

Parses/loads preferences configuration.
protected _loadPrefs ( string $app, boolean $data = false )
$app string The application.
$data boolean Return the data instead of loading into the current object?

generateUI() публичный Метод

Generate the UI for the preferences interface, either for a specific group, or the group selection interface.
public generateUI ( )

getChangeablePrefs() публичный Метод

Returns the list of changeable prefs for a group.
public getChangeablePrefs ( string $group = null ) : array
$group string The preferences group to check.
Результат array The list of changeable prefs.

getDefaultApp() публичный Метод

Get the default application to show preferences for. Defaults to 'horde'.
public getDefaultApp ( ) : string
Результат string The default application.

groupIsEditable() публичный Метод

Determine whether or not a preferences group is editable.
public groupIsEditable ( string $group ) : boolean
$group string The preferences group to check.
Результат boolean Whether or not the group is editable.

handleForm() публичный Метод

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

hasAdvancedPrefs() публичный Метод

Returns whether advanced preferences exist in the current application.
public hasAdvancedPrefs ( ) : boolean
Результат boolean True if at least one of the preferences is an advanced preference.

selfUrl() публичный Метод

Returns a self URL to the current page.
public selfUrl ( array $options = [] ) : Horde_Url
$options array Additional options: 
'special' - (boolean) If set, will trigger special action update
            processing when the URL is loaded.
'token' - (boolean) If set, includes the form token in the URL.
Результат Horde_Url The URL object.

Описание свойств

$_errors защищенное свойство

List of update errors.
protected array $_errors
Результат array

$app публичное свойство

Current application.
public string $app
Результат string

$group публичное свойство

Current preferences group.
public string $group
Результат string

$nobuttons публичное свойство

If set, suppresses display of the buttons.
public bool $nobuttons
Результат boolean

$prefGroups публичное свойство

Preferences groups.
public array $prefGroups
Результат array

$prefs публичное свойство

Preferences.
public array $prefs
Результат array

$suppress публичное свойство

Suppressed preference entries.
public array $suppress
Результат array

$suppressGroups публичное свойство

Suppressed prefGroup entries.
public array $suppressGroups
Результат array

$vars публичное свойство

Form variables for this page load.
public Horde_Variables $vars
Результат Horde_Variables