A checkbox field. More...

Inheritance diagram for HTMLCheckField:

Collaboration diagram for HTMLCheckField:

[legend]

Public Member Functions
	getInputHTML ( $value)
	This function must be implemented to return the HTML to generate the input object itself.

	getInputOOUI ( $value)
	Get the OOUI version of this field.

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

	loadDataFromRequest ( $request)

Public Member Functions inherited from HTMLFormField
	__construct ( $params)
	Initialise the object.

	cancelSubmit ( $value, $alldata)
	Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.

	canDisplayErrors ()
	True if this field type is able to display errors; false if validation errors need to be displayed in the main HTMLForm error area.

	filter ( $value, $alldata)

	getAttributes (array $list)
	Returns the given attributes from the parameters.

	getDefault ()

	getDiv ( $value)
	Get the complete div for the input, including help text, labels, and whatever.

	getErrorsAndErrorClass ( $value)
	Determine form errors to display and their classes.

	getErrorsRaw ( $value)
	Determine form errors to display, returning them in an array.

	getHelpText ()
	Determine the help text to display.

	getHelpTextHtmlDiv ( $helptext)
	Generate help text HTML in div format.

	getHelpTextHtmlRaw ( $helptext)
	Generate help text HTML formatted for raw output.

	getHelpTextHtmlTable ( $helptext)
	Generate help text HTML in table format.

	getInline ( $value)
	Get the complete field as an inline element.

	getLabelHtml ( $cellAttributes=[])

	getOOUI ( $value)
	Get the OOUI version of the div.

	getOptions ()
	Fetch the array of options from the field's parameters.

	getOptionsOOUI ()
	Get options and make them into arrays suitable for OOUI.

	getRaw ( $value)
	Get the complete raw fields for the input, including help text, labels, and whatever.

	getTableRow ( $value)
	Get the complete table row for the input, including help text, labels, and whatever.

	getTooltipAndAccessKey ()
	Returns the attributes required for the tooltip and accesskey, for Html::element() etc.

	getTooltipAndAccessKeyOOUI ()
	Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.

	getVForm ( $value)
	Get the complete field for the input, including help text, labels, and whatever.

	hasVisibleOutput ()
	If this field has a user-visible output or not.

	isHelpInline ()
	Determine if the help text should be displayed inline.

	isHidden ( $alldata)
	Test whether this field is supposed to be hidden, based on the values of the other form fields.

	msg ()
	Get a translated interface message.

	needsJSForHtml5FormValidation ()
	Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.

	setShowEmptyLabel ( $show)
	Tell the field whether to generate a separate label element if its label is blank.

	skipLoadData ( $request)
	Skip this field when collecting data.

	validate ( $value, $alldata)
	Override this function to add specific validation checks on the field input.

Protected Member Functions
	getLabelAlignOOUI ()
	Get label alignment when generating field for OOUI.

	needsLabel ()
	checkboxes don't need a label.

Protected Member Functions inherited from HTMLFormField
	getFieldLayoutOOUI ( $inputField, $config)
	Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.

	getMessage ( $value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.

	getNearestFieldByName ( $alldata, $name)
	Fetch a field value from $alldata for the closest field matching a given name.

	getOOUIModules ()
	Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.

	isHiddenRecurse (array $alldata, array $params)
	Helper function for isHidden to handle recursive data structures.

	isSubmitAttempt (WebRequest $request)
	Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just view it? This can't normally be distinguished for e.g.

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

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>".

static	forceToStringRecursive ( $array)
	Recursively forces values in an array to strings, because issues arise with integer 0 as a value.

Public Attributes inherited from HTMLFormField
	$mParams

HTMLForm null	$mParent

Static Protected Member Functions inherited from HTMLFormField
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Protected Attributes inherited from HTMLFormField
	$mClass = ''

	$mDefault

	$mDir

	$mFilterCallback

	$mHelpClass = false

	$mHideIf = null

	$mID

	$mLabel

	$mName

array bool null	$mOptions = false

	$mOptionsLabelsNotFromMessage = false

bool	$mShowEmptyLabels = true
	If true will generate an empty div element with no label.

	$mValidationCallback

	$mVFormClass = ''

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

References HTMLFormField\$mClass, HTMLFormField\$mID, $value, $wgUseMediaWikiUIEverywhere, HTMLFormField\getAttributes(), and HTMLFormField\getTooltipAndAccessKey().

◆ getInputOOUI()

HTMLCheckField::getInputOOUI ( $value )

Get the OOUI version of this field.

Since: 1.26

Parameters

string $value

Returns: OOUI\CheckboxInputWidget The checkbox widget.

Reimplemented from HTMLFormField.

Definition at line 50 of file HTMLCheckField.php.

References HTMLFormField\$mClass, HTMLFormField\$mID, HTMLFormField\$mName, $value, HTMLFormField\getAttributes(), and HTMLFormField\getTooltipAndAccessKeyOOUI().

◆ getLabel()

HTMLCheckField::getLabel ( )

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

...unless OOUI is being used, in which case we actually return the label here.

Returns: string

Reimplemented from HTMLFormField.

Definition at line 82 of file HTMLCheckField.php.

References HTMLFormField\$mLabel, and HTMLForm\getDisplayFormat().

◆ getLabelAlignOOUI()

HTMLCheckField::getLabelAlignOOUI ( )

protected

Get label alignment when generating field for OOUI.

Returns: string 'left', 'right', 'top' or 'inline'

Reimplemented from HTMLFormField.

Definition at line 99 of file HTMLCheckField.php.

◆ loadDataFromRequest()

HTMLCheckField::loadDataFromRequest ( $request )

Parameters

WebRequest $request

Returns: bool

Reimplemented from HTMLFormField.

Definition at line 116 of file HTMLCheckField.php.

References $request, HTMLFormField\getDefault(), and HTMLFormField\isSubmitAttempt().

◆ needsLabel()

HTMLCheckField::needsLabel ( )

protected

checkboxes don't need a label.

Returns: bool

Reimplemented from HTMLFormField.

Definition at line 107 of file HTMLCheckField.php.

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

includes/htmlform/fields/HTMLCheckField.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getInputHTML()

◆ getInputOOUI()

◆ getLabel()

◆ getLabelAlignOOUI()

◆ loadDataFromRequest()

◆ needsLabel()