An information field (text blob), not a proper input. More...
Public Member Functions | |
| __construct ($info) | |
| Initialise the object. | |
| getDiv ($value) | |
| getInputHTML ($value) | |
| This function must be implemented to return the HTML to generate the input object itself. | |
| getRaw ($value) | |
| getTableRow ($value) | |
| Get the complete table row for the input, including help text, labels, and whatever. | |
Protected Member Functions | |
| needsLabel () | |
| Should this field have a label, or is there no input element with the appropriate id for the label to point to? | |
Detailed Description
An information field (text blob), not a proper input.
Definition at line 6 of file HTMLInfoField.php.
Constructor & Destructor Documentation
| HTMLInfoField::__construct | ( | $ | params | ) |
Initialise the object.
- Parameters:
-
array $params Associative Array. See HTMLForm doc for syntax.
- Since:
- 1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
- Exceptions:
-
MWException
Reimplemented from HTMLFormField.
Definition at line 7 of file HTMLInfoField.php.
Member Function Documentation
| HTMLInfoField::getDiv | ( | $ | value | ) |
- Parameters:
-
string $value
- Returns:
- string
- Since:
- 1.20
Reimplemented from HTMLFormField.
Definition at line 30 of file HTMLInfoField.php.
| HTMLInfoField::getInputHTML | ( | $ | value | ) |
This function must be implemented to return the HTML to generate the input object itself.
It should not implement the surrounding table cells/rows, or labels/help messages.
- Parameters:
-
string $value The value to set the input to; eg a default text for a text input.
- Returns:
- string Valid HTML.
Reimplemented from HTMLFormField.
Definition at line 13 of file HTMLInfoField.php.
| HTMLInfoField::getRaw | ( | $ | value | ) |
- Parameters:
-
string $value
- Returns:
- string
- Since:
- 1.20
Reimplemented from HTMLFormField.
Definition at line 43 of file HTMLInfoField.php.
| HTMLInfoField::getTableRow | ( | $ | value | ) |
Get the complete table row for the input, including help text, labels, and whatever.
- Parameters:
-
string $value The value to set the input to.
- Returns:
- string Complete HTML table row.
Reimplemented from HTMLFormField.
Definition at line 17 of file HTMLInfoField.php.
| HTMLInfoField::needsLabel | ( | ) | [protected] |
Should this field have a label, or is there no input element with the appropriate id for the label to point to?
- Returns:
- bool True to output a label, false to suppress
Reimplemented from HTMLFormField.
Definition at line 51 of file HTMLInfoField.php.
The documentation for this class was generated from the following file:
- includes/htmlform/HTMLInfoField.php
