Jump to content

auFormString: Difference between revisions

From auWiki
New page: {{RightTOC}} FormString Category:Class Category:PHP The auFormString class is part of the auLib package. It is defined in the auForm.php file. ;Hierarchy * ...
 
No edit summary
Line 19: Line 19:
* $name = Name to submit the field as.
* $name = Name to submit the field as.
* ''$label'' = Label to display with the field.  Default is blank.
* ''$label'' = Label to display with the field.  Default is blank.
* ''$tooltip'' = Tooltip text to display when the mouse is over the label.  For checkbox fields, the tooltip displays next to the checkbox itself.  Default is none.
* ''$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.
* ''$required'' = Whether a value is required in this field.  Default is not required.
* ''$default'' = Default value for this field.  Default is blank / unchecked.
* ''$default'' = Default value for this field.  Default is blank / unchecked.
* ''$width'' = Width of the field in characters.  Default is browser default.
* ''$width'' = Width of the field in characters.  Default is browser default.
* ''$maxlength'' = The maximum number of characters the field can accept.  Default is unlimited.
* ''$maxlength'' = The maximum number of characters the field can accept.  Default is unlimited.

Revision as of 14:36, 29 April 2008

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

Hierarchy

Usage

This class is used to add a single-line string input field to a form. Create an object from this class and add it to an auFormContainer object.

Public Functions

new auFormString

new auFormString($name, $label, $tooltip, $required, $default, $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.
  • $width = Width of the field in characters. Default is browser default.
  • $maxlength = The maximum number of characters the field can accept. Default is unlimited.