auFormMultiSelect

From auWiki
Jump to: navigation, search

The auFormMultiSelect class is part of the auLib package. It is defined in the auForm.php file.

Hierarchy

Usage

This class is used to add a multiple-value selection field to a form. Create an object from this class and add it to an auFormContainer object.

Public Functions

new auFormMultiSelect

new auFormMultiSelect($name, $label, $tooltip, $required, $values, $default, $type)

Creates a multiple-value selection field.

  • $name = Name to submit the field as.
  • $label = Label to display with the field. Default is blank.
  • $tooltip = Tooltip text to display when the mouse is over the label. Default is none.
  • $required = Whether a value is required in this field (display only). Default is not required.
  • $values = Associative array of possible values (value => display text). If values and display text are all identical, a normal array can be passed through auFormSelect::ArrayIndex($array) to get it into the appropriate format. Default is no possible values.
  • $default = Array of default values for this field. Default is for no values to be selected.
  • $type = Type of field -- set to _AU_FORM_MULTI_LIST to use list box. Default is _AU_FORM_MULTI_CHECK for checkboxes.