Docs For Class SquirrelOption

Class SquirrelOption

Description

Description | Vars (details) | Methods (details)

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

Variable Summary

Description | Vars (details) | Methods (details)

mixed $caption

mixed $caption_wrap

mixed $comment

mixed $htmlencoded

mixed $layout_type

mixed $name

mixed $new_value

mixed $no_text

mixed $possible_values

mixed $poss_value_folders

mixed $post_script

mixed $raw_option_array

mixed $refresh_level

mixed $save_function

mixed $script

mixed $size

mixed $trailing_text

mixed $trailing_text_is_html

mixed $trailing_text_small

mixed $type

mixed $use_add_widget

mixed $use_delete_widget

mixed $value

mixed $yes_text

Method Summary

Description | Vars (details) | Methods (details)

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

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

void changed ()

void createHTMLWidget ()

string createWidget_Boolean ([boolean $checkbox = TRUE])

void createWidget_Comment ()

string createWidget_EditList ()

string createWidget_EditListAssociative ()

void createWidget_Float ()

string createWidget_FolderList ([boolean $multiple_select = FALSE])

void createWidget_Hidden ()

void createWidget_Info ()

void createWidget_Integer ()

string createWidget_String ([boolean $password = FALSE])

string createWidget_StrList ([boolean $multiple_select = FALSE], [boolean $radio_buttons = FALSE])

string createWidget_Submit ()

void createWidget_TextArea ()

void is_multiple_valued ()

void save ()

void setCaptionWrap ( $caption_wrap)

void setComment ( $comment)

void setLayoutType ( $layout_type)

void setNewValue ( $new_value)

void setNoText ( $no_text)

void setPossValueFolders ( $poss_value_folders)

void setPostScript ( $post_script)

void setSaveFunction ( $save_function)

void setScript ( $script)

void setSize ( $size)

void setTrailingText ( $trailing_text)

void setTrailingTextIsHtml ( $trailing_text_is_html)

void setTrailingTextSmall ( $trailing_text_small)

void setUseAddWidget ( $use_add_widget)

void setUseDeleteWidget ( $use_delete_widget)

void setValue ( $value)

void setYesText ( $yes_text)

Variables

Description | Vars (details) | Methods (details)

mixed $caption (line 76 )

mixed $caption_wrap (line 77 )

mixed $comment (line 82 )

mixed $htmlencoded = false (line 101 )

mixed $layout_type (line 81 )

mixed $name (line 75 )

mixed $new_value (line 99 )

mixed $no_text (line 89 )

mixed $possible_values (line 100 )

mixed $poss_value_folders (line 92 )

mixed $post_script (line 84 )

mixed $raw_option_array (line 74 )

mixed $refresh_level (line 79 )

mixed $save_function (line 95 )

mixed $script (line 83 )

mixed $size (line 80 )

mixed $trailing_text (line 85 )

mixed $trailing_text_is_html (line 87 )

mixed $trailing_text_small (line 86 )

mixed $type (line 78 )

mixed $use_add_widget (line 90 )

mixed $use_delete_widget (line 91 )

mixed $value (line 98 )

mixed $yes_text (line 88 )

Methods

Description | Vars (details) Methods (details)

Constructor SquirrelOption (line 161 )

Constructor (PHP4 style, kept for compatibility reasons)

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

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

Constructor __construct (line 106 )

Constructor (PHP5 style, required in some future version of PHP)

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

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

changed (line 1207 )

void changed ()

createHTMLWidget (line 262 )

void createHTMLWidget ()

createWidget_Boolean (line 668 )

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.

return: html formated boolean widget

string createWidget_Boolean ([boolean $checkbox = TRUE])

boolean $checkbox: When TRUE, the widget will be constructed as a checkbox, otherwise it will be a set of Yes/No radio buttons (OPTIONAL; default is TRUE (checkbox)).

createWidget_Comment (line 725 )

void createWidget_Comment ()

createWidget_EditList (line 740 )

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.

return: html formated list of edit fields and their associated controls

string createWidget_EditList ()

createWidget_EditListAssociative (line 918 )

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.

return: html formated list of edit fields and their associated controls

string createWidget_EditListAssociative ()

createWidget_Float (line 636 )

void createWidget_Float ()

createWidget_FolderList (line 529 )

Create folder selection box

return: html formated selection box

string createWidget_FolderList ([boolean $multiple_select = FALSE])

boolean $multiple_select: When TRUE, the select widget will allow multiple selections (OPTIONAL; default is FALSE (single select list))

createWidget_Hidden (line 718 )

void createWidget_Hidden ()

createWidget_Info (line 348 )

void createWidget_Info ()

createWidget_Integer (line 621 )

void createWidget_Integer ()

createWidget_String (line 365 )

Create text box

return: html formated text input

string createWidget_String ([boolean $password = FALSE])

boolean $password: When TRUE, the text in the input widget will be obscured (OPTIONAL; default = FALSE).

createWidget_StrList (line 423 )

Create selection box or radio 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.

return: html formated selection box or radio buttons

string createWidget_StrList ([boolean $multiple_select = FALSE], [boolean $radio_buttons = FALSE])

boolean $multiple_select: When TRUE, the select widget will allow multiple selections (OPTIONAL; default is FALSE (single select list))
boolean $radio_buttons: When TRUE, the widget will instead be built as a group of radio buttons (and $multiple_select will be forced to FALSE) (OPTIONAL; default is FALSE (select widget))

createWidget_Submit (line 1188 )

Creates a submit button

return: html formated submit button widget

string createWidget_Submit ()

createWidget_TextArea (line 606 )

void createWidget_TextArea ()

is_multiple_valued (line 168 )

Convenience function that identifies which types of

void is_multiple_valued ()

save (line 1202 )

void save ()

setCaptionWrap (line 186 )

void setCaptionWrap ( $caption_wrap)

$caption_wrap

setComment (line 243 )

void setComment ( $comment)

$comment

setLayoutType (line 238 )

void setLayoutType ( $layout_type)

$layout_type

setNewValue (line 181 )

void setNewValue ( $new_value)

$new_value

setNoText (line 216 )

void setNoText ( $no_text)

$no_text

setPossValueFolders (line 233 )

void setPossValueFolders ( $poss_value_folders)

$poss_value_folders

setPostScript (line 253 )

void setPostScript ( $post_script)

$post_script

setSaveFunction (line 258 )

void setSaveFunction ( $save_function)

$save_function

setScript (line 248 )

void setScript ( $script)

$script

setSize (line 191 )

void setSize ( $size)

$size

setTrailingText (line 196 )

void setTrailingText ( $trailing_text)

$trailing_text

setTrailingTextIsHtml (line 206 )

void setTrailingTextIsHtml ( $trailing_text_is_html)

$trailing_text_is_html

setTrailingTextSmall (line 201 )

void setTrailingTextSmall ( $trailing_text_small)

$trailing_text_small

setUseAddWidget (line 221 )

void setUseAddWidget ( $use_add_widget)

$use_add_widget

setUseDeleteWidget (line 226 )

void setUseDeleteWidget ( $use_delete_widget)

$use_delete_widget

setValue (line 176 )

void setValue ( $value)

$value

setYesText (line 211 )

void setYesText ( $yes_text)

$yes_text

Documentation generated on 2020年1月13日 04:25:04 +0100 by phpDocumentor 1.4.3