MediaWiki  REL1_22
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 2736 of file HTMLForm.php.


Constructor & Destructor Documentation

Initialise the object.

Parameters:
array$paramsAssociative 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 2737 of file HTMLForm.php.

Referenced by getInputHTML().


Member Function Documentation

HTMLInfoField::getDiv ( value)
Since:
1.20

Reimplemented from HTMLFormField.

Definition at line 2758 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 2743 of file HTMLForm.php.

References __construct().

HTMLInfoField::getRaw ( value)
Since:
1.20

Reimplemented from HTMLFormField.

Definition at line 2769 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 2747 of file HTMLForm.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 2777 of file HTMLForm.php.


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