Docs For Class SquirrelOption

Description

SquirrelOption: An option for Squirrelmail.

This class is a work in progress. When complete, it will handle presentation and saving of Squirrelmail user options in a simple, streamline manner. Stay tuned for more stuff.

Also, I'd like to ask that people leave this alone (mostly :) until I get it a little further along. That should only be a day or two or three. I will remove this message when it is ready for primetime usage.

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

Variable Summary

mixed $caption

mixed $comment

mixed $htmlencoded

mixed $name

mixed $new_value

mixed $possible_values

mixed $post_script

mixed $refresh_level

mixed $save_function

mixed $script

mixed $size

mixed $type

mixed $value

Method Summary

SquirrelOption SquirrelOption ( $name, $caption, $type, $refresh_level, [ $initial_value = ''], [ $possible_values = ''], [ $htmlencoded = false])

void changed ()

void createHTMLWidget ()

void createWidget_Boolean ()

void createWidget_Comment ()

void createWidget_Float ()

void createWidget_FolderList ()

void createWidget_Hidden ()

void createWidget_Integer ()

void createWidget_String ()

void createWidget_StrList ()

void createWidget_TextArea ()

void save ()

void setComment ( $comment)

void setNewValue ( $new_value)

void setPostScript ( $post_script)

void setSaveFunction ( $save_function)

void setScript ( $script)

void setSize ( $size)

void setValue ( $value)

Variables

mixed $caption (line 61)

mixed $comment (line 65)

mixed $htmlencoded = false (line 76)

mixed $name (line 60)

mixed $new_value (line 74)

mixed $possible_values (line 75)

mixed $post_script (line 67)

mixed $refresh_level (line 63)

mixed $save_function (line 70)

mixed $script (line 66)

mixed $size (line 64)

mixed $type (line 62)

mixed $value (line 73)

Methods

Constructor SquirrelOption (line 78)

SquirrelOption SquirrelOption ( $name, $caption, $type, $refresh_level, [ $initial_value = ''], [ $possible_values = ''], [ $htmlencoded = false])

$name
$caption
$type
$refresh_level
$initial_value
$possible_values
$htmlencoded

changed (line 376)

void changed ()

createHTMLWidget (line 149)

void createHTMLWidget ()

createWidget_Boolean (line 334)

void createWidget_Boolean ()

createWidget_Comment (line 366)

void createWidget_Comment ()

createWidget_Float (line 318)

void createWidget_Float ()

createWidget_FolderList (line 256)

void createWidget_FolderList ()

createWidget_Hidden (line 359)

void createWidget_Hidden ()

createWidget_Integer (line 303)

void createWidget_Integer ()

createWidget_String (line 205)

void createWidget_String ()

createWidget_StrList (line 230)

void createWidget_StrList ()

createWidget_TextArea (line 288)

void createWidget_TextArea ()

save (line 371)

void save ()

setComment (line 130)

void setComment ( $comment)

$comment

setNewValue (line 120)

void setNewValue ( $new_value)

$new_value

setPostScript (line 140)

void setPostScript ( $post_script)

$post_script

setSaveFunction (line 145)

void setSaveFunction ( $save_function)

$save_function

setScript (line 135)

void setScript ( $script)

$script

setSize (line 125)

void setSize ( $size)

$size

setValue (line 115)

void setValue ( $value)

$value