PHP Class Horde_Core_Prefs_Ui_Widgets, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael Slusarz ([email protected])
Mostra file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
addressbooks ( array $data ) : string Create code needed for addressbook selection.
addressbooksInit ( ) Code to run on init for addressbook selection.
addressbooksUpdate ( Horde_Core_Prefs_Ui $ui ) : array Process form data for address book selection.
alarm ( array $data ) : string Create code needed for alarm selection.
alarmInit ( ) Code to run on init for alarms selection.
alarmUpdate ( Horde_Core_Prefs_Ui $ui, array $data ) : array Process form data for alarm selection.
source ( array $data ) : string Create code needed for source selection.
sourceInit ( ) Code to run on init.
sourceUpdate ( Horde_Core_Prefs_Ui $ui ) : array Process form data for source selection.

Method Details

addressbooks() public static method

Create code needed for addressbook selection.
public static addressbooks ( array $data ) : string
$data array 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 string HTML UI code.

addressbooksInit() public static method

Code to run on init for addressbook selection.
public static addressbooksInit ( )

addressbooksUpdate() public static method

Process form data for address book selection.
public static addressbooksUpdate ( Horde_Core_Prefs_Ui $ui ) : array
$ui Horde_Core_Prefs_Ui The UI object.
return 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.

alarm() public static method

Create code needed for alarm selection.
public static alarm ( array $data ) : string
$data array Data items: - 'helplink': (string) [OPTIONAL] Help link. - 'label': (string) Label. - 'pref': (string) Preference name. - 'value': (array) [OPTIONAL] Preference value.
return string HTML UI code.

alarmInit() public static method

Code to run on init for alarms selection.
public static alarmInit ( )

alarmUpdate() public static method

Process form data for alarm selection.
public static alarmUpdate ( Horde_Core_Prefs_Ui $ui, array $data ) : array
$ui Horde_Core_Prefs_Ui The UI object.
$data array Data items:
'pref' - (string) Preference name.
return array TODO

source() public static method

Create code needed for source selection.
public static source ( array $data ) : string
$data array 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 string HTML UI code.

sourceInit() public static method

Code to run on init.
public static sourceInit ( )

sourceUpdate() public static method

Process form data for source selection.
public static sourceUpdate ( Horde_Core_Prefs_Ui $ui ) : array
$ui Horde_Core_Prefs_Ui The UI object.
return 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).