HTMLCheckField Class Reference

A checkbox field. More...

Inheritance diagram for HTMLCheckField:

Collaboration diagram for HTMLCheckField:

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)

---

Detailed Description

A checkbox field.

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

References $value, Xml\check(), getLabel(), HTMLFormField\getTooltipAndAccessKey(), and Html\rawElement().

HTMLCheckField::getLabel

(

)

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

Returns:

String

Reimplemented from HTMLFormField.

Definition at line 1743 of file HTMLForm.php.

Referenced by getInputHTML().

HTMLCheckField::loadDataFromRequest

(

$

request

)

Parameters:

$request

WebRequest

Returns:

String

Reimplemented from HTMLFormField.

Definition at line 1751 of file HTMLForm.php.

References HTMLFormField\getDefault().

---

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

• includes/HTMLForm.php