Docs For Class SquirrelOption

Description

SquirrelOption: An option for Squirrelmail.

Located in /nasmail/functions/options.php (line 51)

Variable Summary

string $caption

string $comment

boolean $htmlencoded

string $name

mixed $new_value

array $possible_values

string $post_script

integer $refresh_level

mixed $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 = ''], [boolean $htmlencoded = false])

boolean 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 ( $comment, string $comments)

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

var: displayed option name

string $comment (line 65)

var: comment property

boolean $htmlencoded = false (line 81)

string $name (line 53)

var: option variable name

mixed $new_value (line 77)

array $possible_values (line 79)

string $post_script (line 69)

integer $refresh_level (line 59)

var: SMOPT_REFRESH_ constants

mixed $save_function (line 72)

string $script (line 67)

integer $size (line 61)

var: SMOPT_SIZE_* constants

string $trailing_text (line 63)

var: trailing_text property

integer $type (line 57)

var: SMOPT_TYPE_* constants

mixed $value (line 75)

Methods

Constructor SquirrelOption (line 93)

Constructor function

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

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

changed (line 472)

return: compares new and old value

boolean changed ()

createHTMLWidget (line 197)

Creates html widget according to object type

string createHTMLWidget ()

createWidget_Boolean (line 416)

Creates boolean widget

string createWidget_Boolean ()

createWidget_Comment (line 456)

Creates comment widget

string createWidget_Comment ()

createWidget_Float (line 395)

Creates float widget

string createWidget_Float ()

createWidget_FolderList (line 316)

Creates folder list (html select with imap folder names) widget

string createWidget_FolderList ()

createWidget_Hidden (line 445)

Creates hidden widget

string createWidget_Hidden ()

createWidget_Integer (line 375)

Creates integer widget

string createWidget_Integer ()

createWidget_String (line 257)

Creates string widget

string createWidget_String ()

createWidget_StrList (line 286)

Creates string list (html select) widget

string createWidget_StrList ()

createWidget_TextArea (line 356)

Creates textarea widget

string createWidget_TextArea ()

save (line 464)

calls custom save function

void save ()

setComment (line 165)

Set the comment for this option.

void setComment ( $comment, string $comments)

string $comments
$comment

setNewValue (line 141)

Set the new value for this option.

void setNewValue (mixed $new_value)

mixed $new_value

setPostScript (line 181)

Set the "post script" for this option.

void setPostScript (string $post_script)

string $post_script

setSaveFunction (line 189)

Set the save function for this option.

void setSaveFunction (string $save_function)

string $save_function

setScript (line 173)

Set the script for this option.

void setScript (string $script)

string $script

setSize (line 149)

Set the size for this option.

void setSize (integer $size)

integer $size: SMOPT_SIZE_* constants

setTrailingText (line 157)

Set the trailing_text for this option.

void setTrailingText (string $trailing_text)

string $trailing_text

setValue (line 133)

Set the value for this option.

void setValue (mixed $value)

mixed $value