Docs For Class SquirrelOption

Description

SquirrelOption: An option for SquirrelMail.

Located in /functions/options.php (line 52)

Variable Summary

string $caption

string $comment

string $folder_filter

bool $htmlencoded

string $name

mixed $new_value

array $possible_values

string $post_script

integer $refresh_level

string $save_function

string $script

integer $size

string $trailing_text

integer $type

mixed $value

Method Summary

SquirrelOption SquirrelOption (string $name, string $caption, integer $type, integer $refresh_level, [mixed $initial_value = ''], [array $possible_values = ''], [bool $htmlencoded = false])

void changed ()

string createHTMLWidget ()

string createWidget_Boolean ()

string createWidget_Comment ()

string createWidget_Float ()

string createWidget_FolderList ()

string createWidget_Hidden ()

string createWidget_Integer ()

string createWidget_String ()

string createWidget_StrList ()

string createWidget_TextArea ()

void save ()

void setComment (string $comment)

void setFolderFilter (string $folder_filter)

void setNewValue (mixed $new_value)

void setPostScript (string $post_script)

void setSaveFunction (string $save_function)

void setScript (string $script)

void setSize (integer $size)

void setTrailingText (string $trailing_text)

void setValue (mixed $value)

Variables

string $caption (line 62)

The text that prefaces setting on the preferences page

string $comment (line 99)

text displayed to the user

Used with SMOPT_TYPE_COMMENT options

string $folder_filter = 'noselect' (line 151)

Controls folder list limits in SMOPT_TYPE_FLDRLIST widget.

See $flag argument in sqimap_mailbox_option_list() function.

since: 1.5.1

bool $htmlencoded = false (line 144)

disables html sanitizing.

WARNING - don't use it, if user input is possible in option or use own sanitizing functions. Currently works only with SMOPT_TYPE_STRLIST.

string $name (line 57)

The name of this setting

mixed $new_value (line 128)

new option value

array $possible_values (line 135)

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

string $post_script (line 110)

script (usually Javascript) that will be placed after (outside of)

the INPUT tag

integer $refresh_level (line 77)

Indicates if a link should be shown to refresh part or all of the window

See SMOPT_REFRESH_* defines

string $save_function (line 116)

The name of the Save Function for this option.

string $script (line 104)

additional javascript or other code added to the user input

integer $size (line 84)

Specifies the size of certain input items

See SMOPT_SIZE_* defines

string $trailing_text (line 92)

Text that follows a text input or select list input on the preferences page

useful for indicating units, meanings of special values, etc.

integer $type (line 69)

The type of INPUT element

See SMOPT_TYPE_* defines

mixed $value (line 123)

default/preselected value for this option

Methods

Constructor SquirrelOption (line 163)

Constructor function

SquirrelOption SquirrelOption (string $name, string $caption, integer $type, integer $refresh_level, [mixed $initial_value = ''], [array $possible_values = ''], [bool $htmlencoded = false])

string $name
string $caption
integer $type
integer $refresh_level
mixed $initial_value
array $possible_values
bool $htmlencoded

changed (line 561)

void changed ()

createHTMLWidget (line 279)

Creates fields on option pages according to option type

Function that calls other createWidget* functions.

return: html formated option field

string createHTMLWidget ()

createWidget_Boolean (line 503)

Creates radio field (yes/no)

return: html formated radio field

string createWidget_Boolean ()

createWidget_Comment (line 545)

Creates comment

return: comment

string createWidget_Comment ()

createWidget_Float (line 484)

Creates field for floating number

Difference from createWidget_String is visible only when javascript is enabled

return: html formated option field

string createWidget_Float ()

createWidget_FolderList (line 399)

Create folder selection box

return: html formated selection box

string createWidget_FolderList ()

createWidget_Hidden (line 534)

Creates hidden field

return: html formated hidden input field

string createWidget_Hidden ()

createWidget_Integer (line 465)

Creates field for integer

Difference from createWidget_String is visible only when javascript is enabled

return: html formated option field

string createWidget_Integer ()

createWidget_String (line 339)

Create string field

return: html formated option field

string createWidget_String ()

createWidget_StrList (line 368)

Create selection box

return: html formated selection box

string createWidget_StrList ()

createWidget_TextArea (line 444)

Creates textarea

return: html formated textarea field

string createWidget_TextArea ()

save (line 553)

void save ()

setComment (line 236)

Set the comment for this option.

void setComment (string $comment)

string $comment

setFolderFilter (line 269)

Set the trailing_text for this option.

since: 1.5.1

void setFolderFilter (string $folder_filter)

string $folder_filter

setNewValue (line 212)

Set the new value for this option.

void setNewValue (mixed $new_value)

mixed $new_value

setPostScript (line 252)

Set the "post script" for this option.

void setPostScript (string $post_script)

string $post_script

setSaveFunction (line 260)

Set the save function for this option.

void setSaveFunction (string $save_function)

string $save_function

setScript (line 244)

Set the script for this option.

void setScript (string $script)

string $script

setSize (line 220)

Set the size for this option.

void setSize (integer $size)

integer $size

setTrailingText (line 228)

Set the trailing_text for this option.

void setTrailingText (string $trailing_text)

string $trailing_text

setValue (line 204)

Set the value for this option.

void setValue (mixed $value)

mixed $value