MediaWiki  REL1_21
HTMLInfoField Class Reference

An information field (text blob), not a proper input. More...

Inheritance diagram for HTMLInfoField:
Collaboration diagram for HTMLInfoField:

List of all members.

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 2426 of file HTMLForm.php.


Constructor & Destructor Documentation

Initialise the object.

Parameters:
array$paramsAssociative Array. See HTMLForm doc for syntax.
Exceptions:
MWException

Reimplemented from HTMLFormField.

Definition at line 2427 of file HTMLForm.php.


Member Function Documentation

HTMLInfoField::getDiv ( value)
Since:
1.20

Reimplemented from HTMLFormField.

Definition at line 2448 of file HTMLForm.php.

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$valuethe value to set the input to; eg a default text for a text input.
Returns:
String valid HTML.

Reimplemented from HTMLFormField.

Definition at line 2433 of file HTMLForm.php.

HTMLInfoField::getRaw ( value)
Since:
1.20

Reimplemented from HTMLFormField.

Definition at line 2459 of file HTMLForm.php.

Get the complete table row for the input, including help text, labels, and whatever.

Parameters:
string$valuethe value to set the input to.
Returns:
String complete HTML table row.

Reimplemented from HTMLFormField.

Definition at line 2437 of file HTMLForm.php.

References empty.

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 2467 of file HTMLForm.php.


The documentation for this class was generated from the following file: