HTMLRadioField Class Reference

Radio checkbox fields. More...

Inherits HTMLFormField.

List of all members.

Public Member Functions

 validate ($value, $alldata)
 Override this function to add specific validation checks on the field input.
 getInputHTML ($value)
 This returns a block of all the radio options, in one cell.
 formatOptions ($options, $value)

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


Member Function Documentation

HTMLRadioField::formatOptions ( options,
value 
)

Definition at line 1296 of file HTMLForm.php.

References $options, Sanitizer::escapeId(), Xml::radio(), and Html::rawElement().

Referenced by getInputHTML().

HTMLRadioField::getInputHTML ( value  ) 

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

See also:
includes/HTMLFormFieldgetInputHTML()

Reimplemented from HTMLFormField.

Definition at line 1290 of file HTMLForm.php.

References formatOptions().

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 1323 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 $all the data collected from the form
Returns:
Mixed Bool true on success, or String error to display.

Reimplemented from HTMLFormField.

Definition at line 1271 of file HTMLForm.php.

References HTMLFormField::flattenOptions(), and wfMsgExt().


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