HTMLInfoField Class Reference

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

Inherits HTMLFormField.

List of all members.

Public Member Functions

 __construct ($info)
 Initialise the object.
 getInputHTML ($value)
 This function must be implemented to return the HTML to generate the input object itself.
 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 1331 of file HTMLForm.php.


Constructor & Destructor Documentation

HTMLInfoField::__construct ( params  ) 

Initialise the object.

Parameters:
$params Associative Array. See HTMLForm doc for syntax.

Reimplemented from HTMLFormField.

Definition at line 1332 of file HTMLForm.php.


Member Function Documentation

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:
$value String 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 1338 of file HTMLForm.php.

HTMLInfoField::getTableRow ( value  ) 

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

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

Reimplemented from HTMLFormField.

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


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

Generated on Sat Apr 30 22:57:39 2011 for MediaWiki by  doxygen 1.5.9