SquirrelOption: An option for SquirrelMail.
Located in /functions/options.php (line 21)
additional javascript or other widget attributes added to the user input; must be an array where keys are attribute names ("onclick", etc) and values are the attribute values.
The text that prefaces setting on the preferences page
Whether or not the caption text is allowed to wrap
Controls folder list limits in SMOPT_TYPE_FLDRLIST and
SMOPT_TYPE_FLDRLIST_MULTI widgets as well as the optional embedded folder lists provided for inputting values for the SMOPT_TYPE_EDIT_LIST and SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE :idgets. See $flag argument in sqimap_mailbox_option_list() function.
disables html sanitizing.
WARNING - don't use it, if user input is possible in option or use own sanitizing functions. Currently only works for SMOPT_TYPE_STRLIST.
Some widgets support more than one layout type
The name of this setting
new option value
Text that overrides the "No" label for boolean radio option widgets
associative array, where each key is an actual input value
and the corresponding value is what is displayed to the user for that list item in the drop-down list
associative array, treated the same as $possible_values
(see its documentation below), but usually expected to have its first value contain a list of IMAP folders, an array itself in the format as passed back by sqimap_mailbox_list(). Used to display folder selector for possible values of an associative edit list option widget
script (usually Javascript) that will be placed after (outside of)
the INPUT tag
The original option configuration array
Indicates if a link should be shown to refresh part or all of the window
See SMOPT_REFRESH_* defines
The name of the Save Function for this option.
Text that follows a text input or select list input on the preferences page
useful for indicating units, meanings of special values, etc.
Indicates that the widget's "trailing text" contains HTML and should not thus be sanitized (encoded)
Indicates that the widget's "trailing text" should be displayed in a smaller sized font
Indicates if the Add widget should be included with edit lists.
Indicates if the Delete widget should be included with edit lists.
default/preselected value for this option
Text that overrides the "Yes" label for boolean radio option widgets
Constructor (PHP4 style, kept for compatibility reasons)
Constructor (PHP5 style, required in some future version of PHP)
Creates fields on option pages according to option type
This is the function that calls all other createWidget* functions.
Create boolean widget
When creating Yes/No radio buttons, the "yes_text" and "no_text" option attributes are used to override the typical "Yes" and "No" text.
Creates a (non-associative) edit list
Note that multiple layout types are supported for this widget. $this->layout_type must be one of the SMOPT_EDIT_LIST_LAYOUT_* constants.
Creates an associative edit list
Note that multiple layout types are supported for this widget. $this->layout_type must be one of the SMOPT_EDIT_LIST_LAYOUT_* constants.
Creates field for floating number
Difference from createWidget_String is visible only when javascript is enabled
Create folder selection box
Creates field for integer
Difference from createWidget_String is visible only when javascript is enabled
Create string field
Create selection box or radio button group
When $this->htmlencoded is TRUE, the keys and values in $this->possible_values are assumed to be display-safe. Use with care!
Note that when building radio buttons instead of a select widget, if the "size" attribute is SMOPT_SIZE_TINY, the radio buttons will be output one after another without linebreaks between them. Otherwise, each radio button goes on a line of its own.
Convenience function that identifies which types of
Set whether the caption is allowed to wrap for this option.
Set the comment for this option.
Set the extra attributes for this option.
Set the folder_filter for this option.
Set the layout type for this option.
Set the new value for this option.
Set the no_text for this option.
Set the "post script" for this option.
Set the save function for this option.
Set the trailing_text for this option.
Set the trailing_text_is_html for this option.
Set the trailing_text_small for this option.
Set the yes_text for this option.
Documentation generated on Mon, 13 Jan 2020 04:23:14 +0100 by phpDocumentor 1.4.3