Class FormControlSelect

Description

A select control based on FormControl for output via a FormUI.

Located in /system/classes/formui.php (line 1289)

FormControl
   |
   --FormControlSelect
Direct descendents
Class Description
FormControlCheckboxes A set of checkbox controls based on FormControl for output via a FormUI.
FormControlRadio A radio control based on FormControl for output via a FormUI.
Variable Summary
mixed $multiple
mixed $options
mixed $size
Method Summary
FormControlSelect __construct (string $name, string $caption, array $options, string $selected)
string get ([boolean $forvalidation = true])
Variables
mixed $multiple = false (line 1292)
  • access: public
mixed $options = array() (line 1291)
  • access: public
mixed $size = 5 (line 1293)
  • access: public

Inherited Variables

Inherited from FormControl

FormControl::$caption
FormControl::$class
FormControl::$container
FormControl::$default
FormControl::$id
FormControl::$name
FormControl::$properties
FormControl::$storage
FormControl::$store_user
FormControl::$template
FormControl::$theme_obj
FormControl::$validators
Methods
Constructor __construct (line 1303)

Override the FormControl constructor to support more parameters

  • access: public
FormControlSelect __construct (string $name, string $caption, array $options, string $selected)
  • string $name
  • string $caption
  • array $options
  • string $selected

Redefinition of:
FormControl::__construct()
FormControl constructor - set initial settings of the control
get (line 1323)

Produce HTML output for this text control.

  • return: HTML that will render this control in the form
  • access: public
string get ([boolean $forvalidation = true])
  • boolean $forvalidation: True if this control should render error information based on validation.

Redefinition of:
FormControl::get()
Return the HTML construction of the control.

Redefined in descendants as:

Inherited Methods

Inherited From FormControl

FormControl::__construct()
FormControl::add_validator()
FormControl::checksum()
FormControl::get()
FormControl::get_default()
FormControl::get_form()
FormControl::get_template()
FormControl::get_theme()
FormControl::has_user_options()
FormControl::move_after()
FormControl::move_before()
FormControl::pre_out()
FormControl::remove()
FormControl::remove_validator()
FormControl::save()
FormControl::validate()
FormControl::__get()
FormControl::__set()
FormControl::__toString()

Documentation generated on Thu, 30 Oct 2008 20:31:14 +0100 by phpDocumentor 1.3.2