API Documentation
\

\Horde_Core_Prefs_Ui_Widgets

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.

Summary

Methods
Properties
Constants
sourceInit()
source()
sourceUpdate()
addressbooksInit()
addressbooks()
addressbooksUpdate()
alarmInit()
alarm()
alarmUpdate()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

sourceInit()

sourceInit()

Code to run on init.

source()

source(array  $data) : string

Create code needed for source selection.

Parameters

array $data

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.

Returns

string —

HTML UI code.

sourceUpdate()

sourceUpdate(\Horde_Core_Prefs_Ui  $ui) : array

Process form data for source selection.

Parameters

\Horde_Core_Prefs_Ui $ui

The UI object.

Returns

array —

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).

addressbooksInit()

addressbooksInit()

Code to run on init for addressbook selection.

addressbooks()

addressbooks(array  $data) : string

Create code needed for addressbook selection.

Parameters

array $data

Data items:

'fields' - (array) Hash containing addressbook sources as keys and an
           array of search fields as values.
'sources' - (array) List of selected addressbooks.

Returns

string —

HTML UI code.

addressbooksUpdate()

addressbooksUpdate(\Horde_Core_Prefs_Ui  $ui) : array

Process form data for address book selection.

Parameters

\Horde_Core_Prefs_Ui $ui

The UI object.

Returns

array —

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.

alarmInit()

alarmInit()

Code to run on init for alarms selection.

alarm()

alarm(array  $data) : string

Create code needed for alarm selection.

Parameters

array $data

Data items:

  • 'helplink': (string) [OPTIONAL] Help link.
  • 'label': (string) Label.
  • 'pref': (string) Preference name.
  • 'value': (array) [OPTIONAL] Preference value.

Returns

string —

HTML UI code.

alarmUpdate()

alarmUpdate(\Horde_Core_Prefs_Ui  $ui, array  $data) : array

Process form data for alarm selection.

Parameters

\Horde_Core_Prefs_Ui $ui

The UI object.
array $data

Data items:

'pref' - (string) Preference name.

Returns

array —

TODO