$cols =
[line 81]
Number of columns for multiline input
$cssClass =
[line 75]
CSS class to use
$dataBased =
[line 102]
Enable or disable use of $dataField
$dataField =
[line 96]
Data field name for looking up initial data
The name stored here is used to lookup initial data for the plugin in the render's variables. Defaults to the ID of the plugin. See also tutorials on the Zikula site.
$errorMessage =
[line 141]
Error message to display when input does not validate
Use pnFormTextInput::setError() and pnFormTextInput::clearValidation() to change the value.
$group =
[line 113]
Group name for this input
The group name is used to locate data in the render (when databased) and to restrict which plugins to do validation on (to be implemented).
Tags:
$inputName =
[line 184]
HTML input name for this plugin. Defaults to the ID of the plugin.
$isValid = true
[line 124]
Validation indicator used by the framework.
The true/false value of this variable indicates whether or not the text input is valid (a valid input satisfies the mandatory requirement and regex validation pattern). Use pnFormTextInput::setError() and pnFormTextInput::clearValidation() to change the value.
$mandatory =
[line 132]
Enable or disable mandatory check
By enabling mandatory checking you force the user to enter something in the text input.
$maxLength =
[line 162]
Maximum number of characters allowed in the text input
$myLabel =
[line 150]
Text label for this plugin
This variable contains the label text for the input. The pnFormLabel plugin will set this text automatically when it is a label for this input.
$readOnly =
[line 63]
Enable or disable read only mode
A text input in read only mode do *not* decode posted data, since the user cannot enter anything in the read only input.
$regexValidationMessage =
[line 178]
Regular expression error message
Error message to display when the regex validation pattern does not match input.
$regexValidationPattern =
[line 170]
Regular expression to match input against
User input must match this pattern. Uses PHP preg_match() to match the input and pattern.
$rows =
[line 87]
Number of rows for multiline input
$size =
[line 156]
Size of HTML input (number of characters)
$text = ''
[line 42]
Displayed text in the text input
This variable contains the text to be displayed in the input. At first page display this variable contains whatever set in the template. At postback it contains user input. User input is always trimmed using the HPH function trim().
$textMode = 'singleline'
[line 54]
Text input mode
The text mode defines what kind of HTML element to render. The possible values are:
- Singleline: renders a normal input element (default).
- Password: renders a input element of type "password" (means you cannot read what you are typing).
- Multiline: renders a textarea element.
$toolTip =
[line 69]
Text to show as tool tip for the input
