Horde_Core_Prefs_Ui_Widgets
in package
Collection of prefs UI widgets for use with application-specific (a/k/a 'special') configuration.
Copyright 2010-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
Methods
- addressbooks() : string
- Create code needed for addressbook selection.
- addressbooksInit() : mixed
- Code to run on init for addressbook selection.
- addressbooksUpdate() : array<string|int, mixed>
- Process form data for address book selection.
- alarm() : string
- Create code needed for alarm selection.
- alarmInit() : mixed
- Code to run on init for alarms selection.
- alarmUpdate() : array<string|int, mixed>
- Process form data for alarm selection.
- source() : string
- Create code needed for source selection.
- sourceInit() : mixed
- Code to run on init.
- sourceUpdate() : array<string|int, mixed>
- Process form data for source selection.
Methods
addressbooks()
Create code needed for addressbook selection.
public
static addressbooks(array<string|int, mixed> $data) : string
Parameters
- $data : array<string|int, mixed>
-
Data items:
'fields' - (array) Hash containing addressbook sources as keys and an array of search fields as values. 'sources' - (array) List of selected addressbooks.
Return values
string —HTML UI code.
addressbooksInit()
Code to run on init for addressbook selection.
public
static addressbooksInit() : mixed
addressbooksUpdate()
Process form data for address book selection.
public
static addressbooksUpdate(Horde_Core_Prefs_Ui $ui) : array<string|int, mixed>
Parameters
- $ui : Horde_Core_Prefs_Ui
-
The UI object.
Return values
array<string|int, mixed> —Array with two possible keys: sources and fields. Sources contains the list of selected addressbooks (JSON encoded). Fields contains a hash containing sources as keys and an array of search fields as the value.
alarm()
Create code needed for alarm selection.
public
static alarm(array<string|int, mixed> $data) : string
Parameters
- $data : array<string|int, mixed>
-
Data items:
- 'helplink': (string) [OPTIONAL] Help link.
- 'label': (string) Label.
- 'pref': (string) Preference name.
- 'value': (array) [OPTIONAL] Preference value.
Return values
string —HTML UI code.
alarmInit()
Code to run on init for alarms selection.
public
static alarmInit() : mixed
alarmUpdate()
Process form data for alarm selection.
public
static alarmUpdate(Horde_Core_Prefs_Ui $ui, array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $ui : Horde_Core_Prefs_Ui
-
The UI object.
- $data : array<string|int, mixed>
-
Data items:
'pref' - (string) Preference name.
Return values
array<string|int, mixed> —TODO
source()
Create code needed for source selection.
public
static source(array<string|int, mixed> $data) : string
Parameters
- $data : array<string|int, mixed>
-
Data items:
'mainlabel' - (string) Main label. 'no_up' - (boolean) [OPTIONAL] Disable movement of selected items up/down. 'selectlabel' - (array) Selected label. 'sourcelabel' - (string) [OPTIONAL] Source selection label. 'sources' - (array) List of sources - keys are source names. Each source is an array with the entries: 'label', 'selected' and 'unselected'. 'unselectlabel' - (array) Unselected label.
Return values
string —HTML UI code.
sourceInit()
Code to run on init.
public
static sourceInit() : mixed
sourceUpdate()
Process form data for source selection.
public
static sourceUpdate(Horde_Core_Prefs_Ui $ui) : array<string|int, mixed>
Parameters
- $ui : Horde_Core_Prefs_Ui
-
The UI object.
Return values
array<string|int, mixed> —If only one source was originally given, contains the list of selected values (JSON encoded). If multiple sources were given, this variable will contain a list of arrays; each subarray contains the source name and the list of selected values (JSON encoded).