HTMLCheckField Class Reference
A checkbox field. More...
Inheritance diagram for HTMLCheckField:
Collaboration diagram for HTMLCheckField:
Public Member Functions | |
| getInputHTML ($value) | |
| getInputOOUI ($value) | |
| Get the OOUI version of this field. 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... | |
| cancelSubmit ($value, $alldata) | |
| Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm. More... | |
| 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. 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... | |
| getErrorsRaw ($value) | |
| Determine form errors to display, returning them in an array. 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... | |
| getInline ($value) | |
| Get the complete field as an inline element. More... | |
| getInputHTML ($value) | |
| This function must be implemented to return the HTML to generate the input object itself. More... | |
| getInputOOUI ($value) | |
| Same as getInputHTML, but returns an OOUI object. More... | |
| getLabel () | |
| getLabelHtml ($cellAttributes=[]) | |
| getNotices () | |
| Determine notices to display for the field. More... | |
| getOOUI ($value) | |
| Get the OOUI version of the div. More... | |
| getOptions () | |
| Fetch the array of options from the field's parameters. More... | |
| getOptionsOOUI () | |
| Get options and make them into arrays suitable for OOUI. 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... | |
| getVForm ($value) | |
| Get the complete field for the input, including help text, labels, and whatever. More... | |
| hasVisibleOutput () | |
| If this field has a user-visible output or not. More... | |
| isHidden ($alldata) | |
| Test whether this field is supposed to be hidden, based on the values of the other form fields. More... | |
| loadDataFromRequest ($request) | |
| Get the value that this input has been set to from a posted form, or the input's default value if it has not been set. 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... | |
| skipLoadData ($request) | |
| Skip this field when collecting data. More... | |
| validate ($value, $alldata) | |
| Override this function to add specific validation checks on the field input. More... | |
Protected Member Functions | |
| getLabelAlignOOUI () | |
| Get label alignment when generating field for OOUI. More... | |
| needsLabel () | |
| checkboxes don't need a label. More... | |
| Protected Member Functions inherited from HTMLFormField | |
| getFieldLayoutOOUI ($inputField, $config) | |
| Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output. More... | |
| getLabelAlignOOUI () | |
| Get label alignment when generating field for OOUI. More... | |
| getMessage ($value) | |
| Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message. More... | |
| getNearestFieldByName ($alldata, $name) | |
| Fetch a field value from $alldata for the closest field matching a given name. More... | |
| isHiddenRecurse (array $alldata, array $params) | |
| Helper function for isHidden to handle recursive data structures. More... | |
| 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. More... | |
| needsLabel () | |
| Should this field have a label, or is there no input element with the appropriate id for the label to point to? 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 null | $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 | |
| $mDir | |
| $mFilterCallback | |
| $mHelpClass = false | |
| $mHideIf = null | |
| $mID | |
| $mLabel | |
| $mName | |
| $mOptions = false | |
| $mOptionsLabelsNotFromMessage = false | |
| bool | $mShowEmptyLabels = true |
| If true will generate an empty div element with no label. More... | |
| $mValidationCallback | |
| $mVFormClass = '' | |
Detailed Description
A checkbox field.
Definition at line 6 of file HTMLCheckField.php.
Member Function Documentation
| HTMLCheckField::getInputHTML | ( | $value | ) |
Definition at line 7 of file HTMLCheckField.php.
References HTMLFormField\$mClass, HTMLFormField\$mID, $value, $wgUseMediaWikiUIEverywhere, Xml\check(), HTMLFormField\getAttributes(), HTMLFormField\getTooltipAndAccessKey(), global, and Html\rawElement().
| HTMLCheckField::getInputOOUI | ( | $value | ) |
Get the OOUI version of this field.
- Since
- 1.26
- Parameters
-
string $value
- Returns
- OOUI\CheckboxInputWidget The checkbox widget.
Definition at line 50 of file HTMLCheckField.php.
References HTMLFormField\$mClass, HTMLFormField\$mID, HTMLFormField\$mName, $value, HTMLFormField\getAttributes(), and HTMLFormField\getTooltipAndAccessKey().
| 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
Definition at line 82 of file HTMLCheckField.php.
References HTMLFormField\$mLabel, and HTMLForm\getDisplayFormat().
|
protected |
Get label alignment when generating field for OOUI.
- Returns
- string 'left', 'right', 'top' or 'inline'
Definition at line 99 of file HTMLCheckField.php.
| HTMLCheckField::loadDataFromRequest | ( | $request | ) |
- Parameters
-
WebRequest $request
- Returns
- bool
Definition at line 116 of file HTMLCheckField.php.
References $request, HTMLFormField\getDefault(), and HTMLFormField\isSubmitAttempt().
|
protected |
The documentation for this class was generated from the following file:
- includes/htmlform/HTMLCheckField.php
