HTMLCheckField Class Reference

A checkbox field. More...

Inherits HTMLFormField.

List of all members.

Public Member Functions

 getInputHTML ($value)
 This function must be implemented to return the HTML to generate the input object itself.
 getLabel ()
 For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow().
 loadDataFromRequest ($request)
 Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.


Detailed Description

A checkbox field.

Definition at line 1035 of file HTMLForm.php.


Member Function Documentation

HTMLCheckField::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 1036 of file HTMLForm.php.

HTMLCheckField::getLabel (  ) 

For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow().

Reimplemented from HTMLFormField.

Definition at line 1054 of file HTMLForm.php.

HTMLCheckField::loadDataFromRequest ( request  ) 

Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.

Parameters:
$request WebRequest
Returns:
String the value

Reimplemented from HTMLFormField.

Definition at line 1058 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