auFormString: Difference between revisions
Misterhaan (talk | contribs) No edit summary |
Misterhaan (talk | contribs) →new auFormString: add validate |
||
| Line 14: | Line 14: | ||
==Public Functions== | ==Public Functions== | ||
===new auFormString=== | ===new auFormString=== | ||
<code>new auFormString($name, ''$label'', ''$tooltip'', ''$required'', ''$default'', ''$width'', ''$maxlength'')</code> | <code>new auFormString($name, ''$label'', ''$tooltip'', ''$required'', ''$default'', ''$width'', ''$maxlength'', ''$validate'')</code> | ||
Creates a new single-line string input form field. | Creates a new single-line string input form field. | ||
| Line 24: | Line 24: | ||
* ''$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. | ||
* ''$validate'' = Format the string is expected to be. An _AU_FORM_STRING_* value. Default is any string. | |||
Revision as of 11:49, 1 February 2011
The auFormString class is part of the auLib package. It is defined in the auForm.php file.
- Hierarchy
- auFormElement
- auFormField
- auFormString
- auFormField
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, $validate)
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.
- $validate = Format the string is expected to be. An _AU_FORM_STRING_* value. Default is any string.