auFormMultiString

From auWiki
Jump to: navigation, search

The auFormMultiString 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-line string input field to a form. Create an object from this class and add it to an auFormContainer object.

Public Functions

new auFormMultiString

new auFormMultiString($name, $label, $tooltip, $required, $default, $bbcode, $width, $maxlength)

Creates a new single-line string input form 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. Default is not required.
  • $default = Default value for this field. Default is blank / unchecked.
  • $bbcode = Whether BB code buttons should be included with this field (not yet implemented). Default is not to include them.
  • $width = Width of the field in characters. Default is browser default.
  • $maxlength = The maximum number of characters the field can accept. Default is unlimited.