MediaWiki  1.23.2
HTMLCheckField Class Reference

A checkbox field. More...

Inheritance diagram for HTMLCheckField:
Collaboration diagram for HTMLCheckField:

Public Member Functions

 getInputHTML ( $value)
 This function must be implemented to return the HTML to generate the input object itself. More...
 
 getLabel ()
 For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow() More...
 
 loadDataFromRequest ( $request)
 
- Public Member Functions inherited from HTMLFormField
 __construct ( $params)
 Initialise the object. More...
 
 filter ( $value, $alldata)
 
 getAttributes (array $list)
 Returns the given attributes from the parameters. More...
 
 getDefault ()
 
 getDiv ( $value)
 Get the complete div for the input, including help text, labels, and whatever. More...
 
 getErrorsAndErrorClass ( $value)
 Determine form errors to display and their classes. More...
 
 getHelpText ()
 Determine the help text to display. More...
 
 getHelpTextHtmlDiv ( $helptext)
 Generate help text HTML in div format. More...
 
 getHelpTextHtmlRaw ( $helptext)
 Generate help text HTML formatted for raw output. More...
 
 getHelpTextHtmlTable ( $helptext)
 Generate help text HTML in table format. More...
 
 getLabelHtml ( $cellAttributes=array())
 
 getOptions ()
 Fetch the array of options from the field's parameters. More...
 
 getRaw ( $value)
 Get the complete raw fields for the input, including help text, labels, and whatever. More...
 
 getTableRow ( $value)
 Get the complete table row for the input, including help text, labels, and whatever. More...
 
 getTooltipAndAccessKey ()
 Returns the attributes required for the tooltip and accesskey. More...
 
 msg ()
 Get a translated interface message. More...
 
 setShowEmptyLabel ( $show)
 Tell the field whether to generate a separate label element if its label is blank. More...
 
 validate ( $value, $alldata)
 Override this function to add specific validation checks on the field input. More...
 

Protected Member Functions

 needsLabel ()
 checkboxes don't need a label. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from HTMLFormField
static flattenOptions ( $options)
 flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>". More...
 
static forceToStringRecursive ( $array)
 Recursively forces values in an array to strings, because issues arise with integer 0 as a value. More...
 
- Public Attributes inherited from HTMLFormField
 $mParams
 
HTMLForm $mParent
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 
- Protected Attributes inherited from HTMLFormField
 $mClass = ''
 
 $mDefault
 
 $mFilterCallback
 
 $mID
 
 $mLabel
 
 $mName
 
 $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 

Detailed Description

A checkbox field.

Definition at line 6 of file HTMLCheckField.php.

Member Function Documentation

◆ getInputHTML()

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
string$valuethe value to set the input to; eg a default text for a text input.
Returns
string Valid HTML.

Reimplemented from HTMLFormField.

Definition at line 7 of file HTMLCheckField.php.

References HTMLFormField\$mClass, HTMLFormField\$mID, $value, array(), Xml\check(), HTMLFormField\getAttributes(), HTMLFormField\getTooltipAndAccessKey(), and Html\rawElement().

◆ getLabel()

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 41 of file HTMLCheckField.php.

◆ loadDataFromRequest()

HTMLCheckField::loadDataFromRequest (   $request)
Parameters
$requestWebRequest
Returns
String

Reimplemented from HTMLFormField.

Definition at line 57 of file HTMLCheckField.php.

References HTMLFormField\getDefault().

◆ needsLabel()

HTMLCheckField::needsLabel ( )
protected

checkboxes don't need a label.

Reimplemented from HTMLFormField.

Definition at line 48 of file HTMLCheckField.php.


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