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 (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
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.
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)).
void
createWidget_Comment
()
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.
string
createWidget_EditList
()
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.
string
createWidget_EditListAssociative
()
void
createWidget_Float
()
Create folder 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))
void
createWidget_Hidden
()
void
createWidget_Info
()
void
createWidget_Integer
()
Create text box
string
createWidget_String
([boolean $password = FALSE])
-
boolean
$password: When TRUE, the text in the input widget will be obscured (OPTIONAL; default = FALSE).
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.
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))
Creates a submit button
string
createWidget_Submit
()
void
createWidget_TextArea
()
Convenience function that identifies which types of
void
is_multiple_valued
()
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
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
setYesText
( $yes_text)