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

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

Here is the call graph for this function:

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

HTMLCheckField::loadDataFromRequest

(

$

request

)

Parameters:

$request

WebRequest

Returns:

String

Reimplemented from HTMLFormField.

Definition at line 1423 of file HTMLForm.php.

References HTMLFormField\getDefault().

Here is the call graph for this function:

---

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

• includes/HTMLForm.php