squirrelmail-webmail  1.4.22
About: SquirrelMail is a standards-based webmail package with strong MIME support, address books, and folder manipulation (written in PHP4).
  Fossies Dox: squirrelmail-webmail-1.4.22.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

SquirrelOption Class Reference

Public Member Functions

 SquirrelOption ($raw_option_array, $name, $caption, $type, $refresh_level, $initial_value='', $possible_values='', $htmlencoded=false)
 
 is_multiple_valued ()
 
 setValue ($value)
 
 setNewValue ($new_value)
 
 setCaptionWrap ($caption_wrap)
 
 setSize ($size)
 
 setTrailingText ($trailing_text)
 
 setYesText ($yes_text)
 
 setNoText ($no_text)
 
 setUseAddWidget ($use_add_widget)
 
 setUseDeleteWidget ($use_delete_widget)
 
 setLayoutType ($layout_type)
 
 setComment ($comment)
 
 setScript ($script)
 
 setPostScript ($post_script)
 
 setSaveFunction ($save_function)
 
 createHTMLWidget ()
 
 createWidget_Info ()
 
 createWidget_String ($password=FALSE)
 
 createWidget_StrList ($multiple_select=FALSE, $radio_buttons=FALSE)
 
 createWidget_FolderList ($multiple_select=FALSE)
 
 createWidget_TextArea ()
 
 createWidget_Integer ()
 
 createWidget_Float ()
 
 createWidget_Boolean ($checkbox=TRUE)
 
 createWidget_Hidden ()
 
 createWidget_Comment ()
 
 createWidget_EditList ()
 
 createWidget_Submit ()
 
 save ()
 
 changed ()
 

Public Attributes

 $raw_option_array
 
 $name
 
 $caption
 
 $caption_wrap
 
 $type
 
 $refresh_level
 
 $size
 
 $layout_type
 
 $comment
 
 $script
 
 $post_script
 
 $trailing_text
 
 $yes_text
 
 $no_text
 
 $use_add_widget
 
 $use_delete_widget
 
 $save_function
 
 $value
 
 $new_value
 
 $possible_values
 
 $htmlencoded =false
 

Detailed Description

Definition at line 71 of file options.php.

Member Function Documentation

◆ changed()

SquirrelOption::changed ( )

Definition at line 837 of file options.php.

References SMOPT_TYPE_EDIT_LIST.

◆ createHTMLWidget()

◆ createWidget_Boolean()

SquirrelOption::createWidget_Boolean (   $checkbox = TRUE)

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.

Parameters
boolean$checkboxWhen 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)).
Returns
string html formated boolean widget

Definition at line 614 of file options.php.

References _(), SMPREF_NO, and SMPREF_YES.

Referenced by createHTMLWidget().

◆ createWidget_Comment()

SquirrelOption::createWidget_Comment ( )

Definition at line 665 of file options.php.

References $comment.

Referenced by createHTMLWidget().

◆ createWidget_EditList()

SquirrelOption::createWidget_EditList ( )

Creates an 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.

Returns
string html formated list of edit fields and their associated controls

Definition at line 680 of file options.php.

References $color, $javascript_on, _(), SMOPT_EDIT_LIST_LAYOUT_SELECT, SMOPT_SIZE_HUGE, SMOPT_SIZE_LARGE, SMOPT_SIZE_MEDIUM, SMOPT_SIZE_NORMAL, SMOPT_SIZE_SMALL, and SMOPT_SIZE_TINY.

Referenced by createHTMLWidget().

◆ createWidget_Float()

SquirrelOption::createWidget_Float ( )

Definition at line 582 of file options.php.

References $javascript_on, and createWidget_String().

Referenced by createHTMLWidget().

◆ createWidget_FolderList()

SquirrelOption::createWidget_FolderList (   $multiple_select = FALSE)

Create folder selection box

Parameters
boolean$multiple_selectWhen TRUE, the select widget will allow multiple selections (OPTIONAL; default is FALSE (single select list))
Returns
string html formated selection box

Definition at line 479 of file options.php.

References $selected, $value, SMOPT_SIZE_HUGE, SMOPT_SIZE_LARGE, SMOPT_SIZE_NORMAL, SMOPT_SIZE_SMALL, SMOPT_SIZE_TINY, and sqimap_mailbox_option_list().

Referenced by createHTMLWidget().

◆ createWidget_Hidden()

SquirrelOption::createWidget_Hidden ( )

Definition at line 658 of file options.php.

Referenced by createHTMLWidget().

◆ createWidget_Info()

SquirrelOption::createWidget_Info ( )

Definition at line 307 of file options.php.

Referenced by createHTMLWidget().

◆ createWidget_Integer()

SquirrelOption::createWidget_Integer ( )

Definition at line 567 of file options.php.

References $javascript_on, and createWidget_String().

Referenced by createHTMLWidget().

◆ createWidget_String()

SquirrelOption::createWidget_String (   $password = FALSE)

Create text box

Parameters
boolean$passwordWhen TRUE, the text in the input widget will be obscured (OPTIONAL; default = FALSE).
Returns
string html formated text input

Definition at line 322 of file options.php.

References SMOPT_SIZE_HUGE, SMOPT_SIZE_LARGE, SMOPT_SIZE_NORMAL, SMOPT_SIZE_SMALL, and SMOPT_SIZE_TINY.

Referenced by createHTMLWidget(), createWidget_Float(), and createWidget_Integer().

◆ createWidget_StrList()

SquirrelOption::createWidget_StrList (   $multiple_select = FALSE,
  $radio_buttons = 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.

Parameters
boolean$multiple_selectWhen TRUE, the select widget will allow multiple selections (OPTIONAL; default is FALSE (single select list))
boolean$radio_buttonsWhen 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))
Returns
string html formated selection box or radio buttons

Definition at line 377 of file options.php.

References $selected, SMOPT_SIZE_HUGE, SMOPT_SIZE_LARGE, SMOPT_SIZE_NORMAL, SMOPT_SIZE_SMALL, and SMOPT_SIZE_TINY.

Referenced by createHTMLWidget().

◆ createWidget_Submit()

SquirrelOption::createWidget_Submit ( )

Creates a submit button

Returns
string html formated submit button widget

Definition at line 821 of file options.php.

Referenced by createHTMLWidget().

◆ createWidget_TextArea()

SquirrelOption::createWidget_TextArea ( )

◆ is_multiple_valued()

SquirrelOption::is_multiple_valued ( )

Convenience function that identifies which types of widgets are stored as (serialized) array values.

Definition at line 148 of file options.php.

References SMOPT_TYPE_EDIT_LIST, SMOPT_TYPE_FLDRLIST_MULTI, and SMOPT_TYPE_STRLIST_MULTI.

◆ save()

SquirrelOption::save ( )

Definition at line 832 of file options.php.

◆ setCaptionWrap()

SquirrelOption::setCaptionWrap (   $caption_wrap)

Definition at line 165 of file options.php.

References $caption_wrap.

◆ setComment()

SquirrelOption::setComment (   $comment)

Definition at line 205 of file options.php.

References $comment.

◆ setLayoutType()

SquirrelOption::setLayoutType (   $layout_type)

Definition at line 200 of file options.php.

References $layout_type.

◆ setNewValue()

SquirrelOption::setNewValue (   $new_value)

Definition at line 160 of file options.php.

References $new_value.

◆ setNoText()

SquirrelOption::setNoText (   $no_text)

Definition at line 185 of file options.php.

References $no_text.

◆ setPostScript()

SquirrelOption::setPostScript (   $post_script)

Definition at line 215 of file options.php.

References $post_script.

◆ setSaveFunction()

SquirrelOption::setSaveFunction (   $save_function)

Definition at line 220 of file options.php.

References $save_function.

◆ setScript()

SquirrelOption::setScript (   $script)

Definition at line 210 of file options.php.

References $script.

◆ setSize()

SquirrelOption::setSize (   $size)

Definition at line 170 of file options.php.

References $size.

◆ setTrailingText()

SquirrelOption::setTrailingText (   $trailing_text)

Definition at line 175 of file options.php.

References $trailing_text.

◆ setUseAddWidget()

SquirrelOption::setUseAddWidget (   $use_add_widget)

Definition at line 190 of file options.php.

References $use_add_widget.

◆ setUseDeleteWidget()

SquirrelOption::setUseDeleteWidget (   $use_delete_widget)

Definition at line 195 of file options.php.

References $use_delete_widget.

◆ setValue()

SquirrelOption::setValue (   $value)

Definition at line 155 of file options.php.

References $value.

◆ setYesText()

SquirrelOption::setYesText (   $yes_text)

Definition at line 180 of file options.php.

References $yes_text.

◆ SquirrelOption()

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

Member Data Documentation

◆ $caption

SquirrelOption::$caption

Definition at line 75 of file options.php.

Referenced by SquirrelOption().

◆ $caption_wrap

SquirrelOption::$caption_wrap

Definition at line 76 of file options.php.

Referenced by setCaptionWrap().

◆ $comment

SquirrelOption::$comment

Definition at line 81 of file options.php.

Referenced by createWidget_Comment(), and setComment().

◆ $htmlencoded

SquirrelOption::$htmlencoded =false

Definition at line 97 of file options.php.

Referenced by SquirrelOption().

◆ $layout_type

SquirrelOption::$layout_type

Definition at line 80 of file options.php.

Referenced by setLayoutType().

◆ $name

SquirrelOption::$name

Definition at line 74 of file options.php.

Referenced by SquirrelOption().

◆ $new_value

SquirrelOption::$new_value

Definition at line 95 of file options.php.

Referenced by createHTMLWidget(), and setNewValue().

◆ $no_text

SquirrelOption::$no_text

Definition at line 86 of file options.php.

Referenced by setNoText().

◆ $possible_values

SquirrelOption::$possible_values

Definition at line 96 of file options.php.

Referenced by SquirrelOption().

◆ $post_script

SquirrelOption::$post_script

Definition at line 83 of file options.php.

Referenced by createHTMLWidget(), and setPostScript().

◆ $raw_option_array

SquirrelOption::$raw_option_array

Definition at line 73 of file options.php.

Referenced by SquirrelOption().

◆ $refresh_level

SquirrelOption::$refresh_level

Definition at line 78 of file options.php.

Referenced by SquirrelOption().

◆ $save_function

SquirrelOption::$save_function

Definition at line 91 of file options.php.

Referenced by setSaveFunction().

◆ $script

SquirrelOption::$script

Definition at line 82 of file options.php.

Referenced by setScript().

◆ $size

SquirrelOption::$size

Definition at line 79 of file options.php.

Referenced by setSize().

◆ $trailing_text

SquirrelOption::$trailing_text

Definition at line 84 of file options.php.

Referenced by setTrailingText().

◆ $type

SquirrelOption::$type

Definition at line 77 of file options.php.

Referenced by SquirrelOption().

◆ $use_add_widget

SquirrelOption::$use_add_widget

Definition at line 87 of file options.php.

Referenced by setUseAddWidget().

◆ $use_delete_widget

SquirrelOption::$use_delete_widget

Definition at line 88 of file options.php.

Referenced by setUseDeleteWidget().

◆ $value

SquirrelOption::$value

Definition at line 94 of file options.php.

Referenced by createHTMLWidget(), createWidget_FolderList(), and setValue().

◆ $yes_text

SquirrelOption::$yes_text

Definition at line 85 of file options.php.

Referenced by setYesText().


The documentation for this class was generated from the following file: