Class Horde_Core_Prefs_Ui_Widgets
Collection of prefs UI widgets for use with application-specific (a/k/a
'special') configuration.
Copyright 2010-2012 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.
Methods summary
public static
|
|
public static
string
|
#
source( array $data )
Create code needed for source selection.
Create code needed for source selection.
Parameters
- $data
- Data items:
<pre><span class="php-quote">'mainlabel'</span> - (string) Main label.
<span class="php-quote">'no_up'</span> - (boolean) [OPTIONAL] Disable movement of selected items
up/down.
<span class="php-quote">'selectlabel'</span> - (<span class="php-keyword1">array</span>) Selected label.
<span class="php-quote">'sourcelabel'</span> - (string) [OPTIONAL] Source selection label.
<span class="php-quote">'sources'</span> - (<span class="php-keyword1">array</span>) <span class="php-keyword1">List</span> of sources - keys are source names. <span class="php-keyword2">Each</span>
source is an <span class="php-keyword1">array</span> with two entries - selected <span class="php-keyword1">and</span>
unselected.
<span class="php-quote">'unselectlabel'</span> - (<span class="php-keyword1">array</span>) Unselected label.</pre>
Returns
string
HTML UI code.
|
public static
array
|
#
sourceUpdate( Horde_Core_Prefs_Ui $ui )
Process form data for source selection.
Process form data for source selection.
Parameters
Returns
arrayIf 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).
|
public static
|
#
addressbooksInit( )
Code to run on init for addressbook selection.
Code to run on init for addressbook selection.
|
public static
string
|
#
addressbooks( array $data )
Create code needed for addressbook selection.
Create code needed for addressbook selection.
Parameters
- $data
- Data items:
<pre><span class="php-quote">'fields'</span> - (<span class="php-keyword1">array</span>) <span class="php-keyword2">Hash</span> containing addressbook sources <span class="php-keyword1">as</span> keys <span class="php-keyword1">and</span> an
<span class="php-keyword1">array</span> of search fields <span class="php-keyword1">as</span> values.
<span class="php-quote">'sources'</span> - (<span class="php-keyword1">array</span>) <span class="php-keyword1">List</span> of selected addressbooks.</pre>
Returns
string
HTML UI code.
|
public static
array
|
#
addressbooksUpdate( Horde_Core_Prefs_Ui $ui )
Process form data for address book selection.
Process form data for address book selection.
Parameters
Returns
arrayArray 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.
|
public static
|
#
alarmInit( )
Code to run on init for alarms selection.
Code to run on init for alarms selection.
|
public static
string
|
#
alarm( array $data )
Create code needed for alarm selection.
Create code needed for alarm selection.
Parameters
- $data
- <p>Data items:
- 'helplink': (string) [OPTIONAL] Help link.
- 'label': (string) Label.
- 'pref': (string) Preference name.
- 'value': (array) [OPTIONAL] Preference value.</p>
Returns
string
HTML UI code.
|
public static
array
|
#
alarmUpdate( Horde_Core_Prefs_Ui $ui, array $data )
Process form data for alarm selection.
Process form data for alarm selection.
Parameters
- $ui
- The UI object.
- $data
- Data items:
<span class="php-quote">'pref'</span> - (string) Preference name.
Returns
array
TODO
|