HTMLRadioField Class Reference

Radio checkbox fields. More...

Inheritance diagram for HTMLRadioField:

Collaboration diagram for HTMLRadioField:

List of all members.

Public Member Functions
	formatOptions ($options, $value)
	getInputHTML ($value)
	This returns a block of all the radio options, in one cell.
	validate ($value, $alldata)
	Override this function to add specific validation checks on the field input.
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

Radio checkbox fields.

Definition at line 2184 of file HTMLForm.php.

---

Member Function Documentation

HTMLRadioField::formatOptions	(	$	options,
		$	value
	)

Definition at line 2219 of file HTMLForm.php.

HTMLRadioField::getInputHTML

(

$

value

)

This returns a block of all the radio options, in one cell.

See also:

includes/HTMLFormFieldgetInputHTML()

Parameters:

$value

String

Returns:

String

Reimplemented from HTMLFormField.

Definition at line 2213 of file HTMLForm.php.

HTMLRadioField::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 2250 of file HTMLForm.php.

HTMLRadioField::validate	(	$	value,
		$	alldata
	)

Override this function to add specific validation checks on the field input.

Don't forget to call parent::validate() to ensure that the user-defined callback mValidationCallback is still run

Parameters:

$value	String the value the field was submitted with
$alldata	Array the data collected from the form

Returns:

Mixed Bool true on success, or String error to display.

Reimplemented from HTMLFormField.

Definition at line 2187 of file HTMLForm.php.

---

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

• includes/HTMLForm.php