MediaWiki master
|
The parent class to generate form fields. More...
Inherited by HTMLApiField, HTMLButtonField, HTMLCheckField, HTMLCheckMatrix, HTMLEditTools, HTMLExpiryField, HTMLFileField, HTMLFormFieldCloner, HTMLFormFieldWithButton, HTMLHiddenField, HTMLInfoField, HTMLMultiSelectField, HTMLRadioField, HTMLRestrictionsField, HTMLSelectField, HTMLSelectNamespace, HTMLTagFilter, HTMLTextAreaField, HTMLTextField, and Licenses.
Public Member Functions | |
__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. | |
getInputHTML ( $value) | |
This function must be implemented to return the HTML to generate the input object itself. | |
getInputOOUI ( $value) | |
Same as getInputHTML, but returns an OOUI object. | |
getLabel () | |
getLabelHtml ( $cellAttributes=[]) | |
getName () | |
Get the field name that will be used for submission. | |
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. | |
isDisabled ( $alldata) | |
Test whether this field is supposed to be disabled, based on the values of the other form fields. | |
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. | |
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. | |
msg ( $key,... $params) | |
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. | |
Static Public Member Functions | |
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 | |
array array[] | $mParams |
HTMLForm null | $mParent |
Protected Member Functions | |
checkStateRecurse (array $alldata, array $params) | |
Helper function for isHidden and isDisabled to handle recursive data structures. | |
getClassName () | |
Gets the non namespaced class name. | |
getFieldLayoutOOUI ( $inputField, $config) | |
Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output. | |
getLabelAlignOOUI () | |
Get label alignment when generating field for OOUI. | |
getMessage ( $value) | |
Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message. | |
getNearestField ( $name, $backCompat=false) | |
Get the closest field matching a given name. | |
getNearestFieldByName ( $alldata, $name, $asDisplay=false) | |
Fetch a field value from $alldata for the closest field matching a given name. | |
getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false) | |
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. | |
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. | |
needsLabel () | |
Should this field have a label, or is there no input element with the appropriate id for the label to point to? | |
parseCondState ( $params) | |
Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML. | |
parseCondStateForClient () | |
Parse the cond-state array for client-side. | |
shouldInfuseOOUI () | |
Whether the field should be automatically infused. | |
validateCondState ( $params) | |
Validate the cond-state params, the existence check of fields should be done later. | |
Static Protected Member Functions | |
static | formatErrors ( $errors) |
Formats one or more errors as accepted by field validation-callback. | |
Protected Attributes | |
$mClass = '' | |
array | $mCondState = [] |
Array to hold params for 'hide-if' or 'disable-if' statements. | |
$mCondStateClass = [] | |
$mDefault | |
$mDir | |
$mFilterCallback | |
$mHelpClass = false | |
$mID | |
$mLabel | |
$mName | |
array null false | $mOptions = false |
$mOptionsLabelsNotFromMessage = false | |
bool | $mShowEmptyLabels = true |
If true will generate an empty div element with no label. | |
$mVFormClass = '' | |
The parent class to generate form fields.
Any field type should be a subclass of this.
Definition at line 14 of file HTMLFormField.php.
HTMLFormField::__construct | ( | $params | ) |
Initialise the object.
array | $params | Associative Array. See HTMLForm doc for syntax. |
Reimplemented in HTMLButtonField, HTMLFormFieldWithButton, HTMLInfoField, HTMLSelectNamespaceWithButton, HTMLTextFieldWithButton, HTMLAutoCompleteSelectField, HTMLCheckMatrix, HTMLDateTimeField, HTMLFileField, HTMLFormFieldCloner, HTMLHiddenField, HTMLMultiSelectField, HTMLRadioField, HTMLSelectAndOtherField, HTMLSelectLanguageField, HTMLSelectNamespace, HTMLSelectOrOtherField, HTMLTextAreaField, HTMLTextField, HTMLTimezoneField, HTMLTitlesMultiselectField, HTMLTitleTextField, HTMLUserTextField, and Licenses.
Definition at line 504 of file HTMLFormField.php.
References getMessage(), validateCondState(), and wfDeprecatedMsg().
HTMLFormField::cancelSubmit | ( | $value, | |
$alldata | |||
) |
Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.
string | array | $value | The value the field was submitted with |
array | $alldata | The data collected from the form |
Reimplemented in HTMLFormFieldCloner.
Definition at line 379 of file HTMLFormField.php.
HTMLFormField::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.
Reimplemented in HTMLHiddenField.
Definition at line 83 of file HTMLFormField.php.
References hasVisibleOutput().
|
protected |
Helper function for isHidden and isDisabled to handle recursive data structures.
array | $alldata | |
array | $params |
Definition at line 261 of file HTMLFormField.php.
References checkStateRecurse(), getNearestFieldValue(), and true.
Referenced by checkStateRecurse(), isDisabled(), and isHidden().
HTMLFormField::filter | ( | $value, | |
$alldata | |||
) |
mixed | $value | |
mixed[] | $alldata |
Definition at line 430 of file HTMLFormField.php.
|
static |
flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>".
array | $options | Associative Array with values either Strings or Arrays |
Definition at line 1227 of file HTMLFormField.php.
Referenced by HTMLSelectAndOtherField\__construct(), HTMLCheckMatrix\filterDataForSubmit(), HTMLMultiSelectField\filterDataForSubmit(), HTMLAutoCompleteSelectField\getInputHTML(), HTMLSelectOrOtherField\getInputHTML(), HTMLSelectOrOtherField\getInputOOUI(), MediaWiki\Preferences\DefaultPreferencesFactory\getOptionFromUser(), HTMLAutoCompleteSelectField\validate(), HTMLMultiSelectField\validate(), HTMLRadioField\validate(), and HTMLSelectField\validate().
|
static |
Recursively forces values in an array to strings, because issues arise with integer 0 as a value.
array | string | $array |
Definition at line 1169 of file HTMLFormField.php.
Referenced by HTMLMultiSelectField\filterDataForSubmit(), and HTMLMultiSelectField\getInputHTML().
|
staticprotected |
Formats one or more errors as accepted by field validation-callback.
string | Message | array | $errors | Array of strings or Message instances To work around limitations in phan-taint-check the calling class has taintedness disabled. So instead we pretend that this method outputs html, since the result is eventually outputted anyways without escaping and this allows us to verify stuff is safe even though the caller has taintedness cleared. |
Definition at line 1254 of file HTMLFormField.php.
References Message\parse().
HTMLFormField::getAttributes | ( | array | $list | ) |
Returns the given attributes from the parameters.
array | $list | List of attributes to get |
Reimplemented in HTMLAutoCompleteSelectField, HTMLComboboxField, and HTMLDateTimeField.
Definition at line 1124 of file HTMLFormField.php.
Referenced by HTMLMultiSelectField\formatOptions(), HTMLRadioField\formatOptions(), HTMLButtonField\getInputHTML(), HTMLCheckField\getInputHTML(), HTMLCheckMatrix\getInputHTML(), HTMLFileField\getInputHTML(), HTMLFormFieldWithButton\getInputHTML(), HTMLSelectAndOtherField\getInputHTML(), HTMLSelectField\getInputHTML(), HTMLTextAreaField\getInputHTML(), HTMLTextField\getInputHTML(), HTMLButtonField\getInputOOUI(), HTMLCheckField\getInputOOUI(), HTMLCheckMatrix\getInputOOUI(), HTMLFileField\getInputOOUI(), HTMLFormFieldWithButton\getInputOOUI(), HTMLMultiSelectField\getInputOOUI(), HTMLRadioField\getInputOOUI(), HTMLSelectAndOtherField\getInputOOUI(), HTMLSelectField\getInputOOUI(), HTMLSelectOrOtherField\getInputOOUI(), HTMLTextAreaField\getInputOOUI(), HTMLTextField\getInputOOUI(), and HTMLToggleSwitchField\getInputOOUI().
|
protected |
Gets the non namespaced class name.
Definition at line 782 of file HTMLFormField.php.
Referenced by HTMLFormFieldCloner\__construct(), getDiv(), getOOUI(), HTMLCheckMatrix\getTableRow(), and getTableRow().
HTMLFormField::getDefault | ( | ) |
Reimplemented in HTMLCheckField, HTMLCheckMatrix, HTMLFormFieldCloner, HTMLInfoField, HTMLMultiSelectField, HTMLRestrictionsField, and HTMLSelectAndOtherField.
Definition at line 1084 of file HTMLFormField.php.
Referenced by HTMLButtonField\getInputHTML(), HTMLButtonField\getInputOOUI(), HTMLAutoCompleteSelectField\loadDataFromRequest(), HTMLDateTimeField\loadDataFromRequest(), HTMLNamespacesMultiselectField\loadDataFromRequest(), HTMLSelectOrOtherField\loadDataFromRequest(), HTMLTagMultiselectField\loadDataFromRequest(), HTMLTitlesMultiselectField\loadDataFromRequest(), HTMLUsersMultiselectField\loadDataFromRequest(), and loadDataFromRequest().
HTMLFormField::getDiv | ( | $value | ) |
Get the complete div for the input, including help text, labels, and whatever.
string | $value | The value to set the input to. |
Reimplemented in HTMLApiField, HTMLEditTools, HTMLHiddenField, HTMLInfoField, and HTMLTagFilter.
Definition at line 653 of file HTMLFormField.php.
References getClassName(), getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlDiv(), getInputHTML(), getLabelHtml(), and parseCondStateForClient().
Referenced by HTMLForm\formatField(), getOOUI(), and getVForm().
HTMLFormField::getErrorsAndErrorClass | ( | $value | ) |
Determine form errors to display and their classes.
phan-taint-check gets confused with returning both classes and errors and thinks double escaping is happening, so specify that return value has no taint.
string | $value | The value of the input |
Definition at line 1002 of file HTMLFormField.php.
Referenced by getDiv(), getInline(), getRaw(), HTMLCheckMatrix\getTableRow(), and getTableRow().
HTMLFormField::getErrorsRaw | ( | $value | ) |
Determine form errors to display, returning them in an array.
string | $value | The value of the input |
Definition at line 1019 of file HTMLFormField.php.
Referenced by getOOUI().
|
protected |
Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
OOUI\\Widget | $inputField | |
array | $config |
Reimplemented in HTMLSelectNamespaceWithButton, and HTMLTextFieldWithButton.
Definition at line 802 of file HTMLFormField.php.
Referenced by getOOUI().
HTMLFormField::getHelpText | ( | ) |
Determine the help text to display.
Definition at line 961 of file HTMLFormField.php.
Referenced by getDiv(), getInline(), getOOUI(), getRaw(), HTMLCheckMatrix\getTableRow(), and getTableRow().
HTMLFormField::getHelpTextHtmlDiv | ( | $helptext | ) |
Generate help text HTML in div format.
string | null | $helptext |
Definition at line 914 of file HTMLFormField.php.
References parseCondStateForClient().
Referenced by getDiv(), getHelpTextHtmlRaw(), and getInline().
HTMLFormField::getHelpTextHtmlRaw | ( | $helptext | ) |
Generate help text HTML formatted for raw output.
string | null | $helptext |
Definition at line 939 of file HTMLFormField.php.
References getHelpTextHtmlDiv().
Referenced by getRaw().
HTMLFormField::getHelpTextHtmlTable | ( | $helptext | ) |
Generate help text HTML in table format.
string | null | $helptext |
Definition at line 886 of file HTMLFormField.php.
References parseCondStateForClient().
Referenced by HTMLCheckMatrix\getTableRow(), and getTableRow().
HTMLFormField::getInline | ( | $value | ) |
Get the complete field as an inline element.
string | $value | The value to set the input to. |
Definition at line 870 of file HTMLFormField.php.
References getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlDiv(), getInputHTML(), and getLabelHtml().
Referenced by HTMLForm\formatField().
|
abstract |
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.
mixed | $value | The value to set the input to; eg a default text for a text input. |
Reimplemented in HTMLApiField, HTMLAutoCompleteSelectField, HTMLButtonField, HTMLCheckField, HTMLCheckMatrix, HTMLComboboxField, HTMLEditTools, HTMLExpiryField, HTMLFileField, HTMLFormFieldWithButton, HTMLHiddenField, HTMLInfoField, HTMLMultiSelectField, HTMLNamespacesMultiselectField, HTMLRadioField, HTMLRestrictionsField, HTMLSelectAndOtherField, HTMLSelectField, HTMLSelectNamespace, HTMLSelectNamespaceWithButton, HTMLSelectOrOtherField, HTMLSizeFilterField, HTMLTagFilter, HTMLTagMultiselectField, HTMLTextAreaField, HTMLTextField, HTMLTextFieldWithButton, HTMLTitlesMultiselectField, HTMLUsersMultiselectField, Licenses, and HTMLFormFieldCloner.
Referenced by getDiv(), getInline(), getRaw(), and getTableRow().
HTMLFormField::getInputOOUI | ( | $value | ) |
Same as getInputHTML, but returns an OOUI object.
Defaults to false, which getOOUI will interpret as "use the HTML version"
string | $value |
Reimplemented in HTMLAutoCompleteSelectField, HTMLButtonField, HTMLCheckField, HTMLCheckMatrix, HTMLComboboxField, HTMLDateTimeField, HTMLExpiryField, HTMLFileField, HTMLFormFieldWithButton, HTMLInfoField, HTMLMultiSelectField, HTMLNamespacesMultiselectField, HTMLRadioField, HTMLRestrictionsField, HTMLSelectAndOtherField, HTMLSelectField, HTMLSelectNamespace, HTMLSelectOrOtherField, HTMLTagFilter, HTMLTagMultiselectField, HTMLTextAreaField, HTMLTextField, HTMLTitlesMultiselectField, HTMLToggleSwitchField, HTMLUsersMultiselectField, and HTMLFormFieldCloner.
Definition at line 73 of file HTMLFormField.php.
Referenced by getOOUI().
HTMLFormField::getLabel | ( | ) |
Reimplemented in HTMLCheckField.
Definition at line 1042 of file HTMLFormField.php.
Referenced by getOOUI().
|
protected |
Get label alignment when generating field for OOUI.
Reimplemented in HTMLCheckField.
Definition at line 792 of file HTMLFormField.php.
Referenced by getOOUI().
HTMLFormField::getLabelHtml | ( | $cellAttributes = [] | ) |
array | $cellAttributes |
Reimplemented in UploadSourceField.
Definition at line 1052 of file HTMLFormField.php.
Referenced by getDiv(), getInline(), getRaw(), HTMLCheckMatrix\getTableRow(), and getTableRow().
|
protected |
Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.
mixed | $value |
Definition at line 1279 of file HTMLFormField.php.
References Message\newFromSpecifier().
Referenced by HTMLButtonField\__construct(), HTMLAutoCompleteSelectField\__construct(), HTMLFileField\__construct(), HTMLSelectAndOtherField\__construct(), HTMLTextAreaField\__construct(), HTMLTextField\__construct(), __construct(), and HTMLEditTools\formatMsg().
HTMLFormField::getName | ( | ) |
Get the field name that will be used for submission.
Definition at line 123 of file HTMLFormField.php.
|
protected |
Get the closest field matching a given name.
It can handle array fields like the user would expect. The general algorithm is to look for $name as a sibling of $this, then a sibling of $this's parent, and so on.
string | $name | |
bool | $backCompat | Whether to try striping the 'wp' prefix. |
Definition at line 138 of file HTMLFormField.php.
Referenced by getNearestFieldValue(), and parseCondState().
|
protected |
Fetch a field value from $alldata for the closest field matching a given name.
array | $alldata | |
string | $name | |
bool | $asDisplay |
Definition at line 197 of file HTMLFormField.php.
References getNearestFieldValue().
|
protected |
Fetch a field value from $alldata for the closest field matching a given name.
array | $alldata | |
string | $name | |
bool | $asDisplay | Whether the reverting logic of HTMLCheckField should be ignored. |
bool | $backCompat | Whether to try striping the 'wp' prefix. |
Definition at line 167 of file HTMLFormField.php.
References getNearestField().
Referenced by checkStateRecurse(), and getNearestFieldByName().
HTMLFormField::getOOUI | ( | $value | ) |
Get the OOUI version of the div.
Falls back to getDiv by default.
string | $value | The value to set the input to. |
Reimplemented in HTMLInfoField, and HTMLTagFilter.
Definition at line 702 of file HTMLFormField.php.
References getClassName(), getDiv(), getErrorsRaw(), getFieldLayoutOOUI(), getHelpText(), getInputOOUI(), getLabel(), getLabelAlignOOUI(), getOOUIModules(), isHelpInline(), parseCondStateForClient(), and shouldInfuseOOUI().
Referenced by OOUIHTMLForm\formatField().
|
protected |
Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.
Reimplemented in HTMLCheckMatrix, HTMLDateTimeField, HTMLExpiryField, HTMLNamespacesMultiselectField, HTMLSelectAndOtherField, HTMLSelectNamespace, HTMLSelectOrOtherField, HTMLSizeFilterField, HTMLTagMultiselectField, HTMLTitlesMultiselectField, HTMLTitleTextField, HTMLToggleSwitchField, HTMLUsersMultiselectField, and HTMLUserTextField.
Definition at line 826 of file HTMLFormField.php.
Referenced by getOOUI().
HTMLFormField::getOptions | ( | ) |
Fetch the array of options from the field's parameters.
In order, this checks 'options-messages', 'options', then 'options-message'.
Definition at line 1183 of file HTMLFormField.php.
Referenced by HTMLAutoCompleteSelectField\__construct(), HTMLSelectAndOtherField\__construct(), HTMLSelectOrOtherField\__construct(), HTMLMultiSelectField\filterDataForSubmit(), HTMLAutoCompleteSelectField\getAttributes(), HTMLAutoCompleteSelectField\getInputHTML(), HTMLComboboxField\getInputHTML(), HTMLMultiSelectField\getInputHTML(), HTMLRadioField\getInputHTML(), HTMLSelectField\getInputHTML(), HTMLSelectOrOtherField\getInputHTML(), HTMLMultiSelectField\getInputOOUI(), HTMLRadioField\getInputOOUI(), HTMLSelectOrOtherField\getInputOOUI(), HTMLAutoCompleteSelectField\validate(), HTMLMultiSelectField\validate(), HTMLRadioField\validate(), and HTMLSelectField\validate().
HTMLFormField::getOptionsOOUI | ( | ) |
Get options and make them into arrays suitable for OOUI.
Reimplemented in HTMLMultiSelectField.
Definition at line 1210 of file HTMLFormField.php.
Referenced by HTMLComboboxField\getInputOOUI(), HTMLSelectAndOtherField\getInputOOUI(), HTMLSelectField\getInputOOUI(), and HTMLSelectOrOtherField\getInputOOUI().
HTMLFormField::getRaw | ( | $value | ) |
Get the complete raw fields for the input, including help text, labels, and whatever.
string | $value | The value to set the input to. |
Reimplemented in HTMLApiField, HTMLEditTools, HTMLHiddenField, and HTMLInfoField.
Definition at line 840 of file HTMLFormField.php.
References getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlRaw(), getInputHTML(), and getLabelHtml().
Referenced by HTMLForm\formatField().
HTMLFormField::getTableRow | ( | $value | ) |
Get the complete table row for the input, including help text, labels, and whatever.
string | $value | The value to set the input to. |
Reimplemented in HTMLApiField, HTMLCheckMatrix, HTMLEditTools, HTMLHiddenField, HTMLInfoField, and HTMLTagFilter.
Definition at line 595 of file HTMLFormField.php.
References getClassName(), getErrorsAndErrorClass(), getHelpText(), getHelpTextHtmlTable(), getInputHTML(), getLabelHtml(), and parseCondStateForClient().
Referenced by HTMLForm\formatField().
HTMLFormField::getTooltipAndAccessKey | ( | ) |
Returns the attributes required for the tooltip and accesskey, for Html::element() etc.
Definition at line 1093 of file HTMLFormField.php.
Referenced by HTMLCheckField\getInputHTML(), HTMLFileField\getInputHTML(), HTMLTextAreaField\getInputHTML(), and HTMLTextField\getInputHTML().
HTMLFormField::getTooltipAndAccessKeyOOUI | ( | ) |
Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.
Definition at line 1106 of file HTMLFormField.php.
Referenced by HTMLCheckField\getInputOOUI(), HTMLFileField\getInputOOUI(), HTMLTextAreaField\getInputOOUI(), HTMLTextField\getInputOOUI(), and HTMLToggleSwitchField\getInputOOUI().
HTMLFormField::getVForm | ( | $value | ) |
Get the complete field for the input, including help text, labels, and whatever.
Fall back from 'vform' to 'div' when not overridden.
string | $value | The value to set the input to. |
Definition at line 857 of file HTMLFormField.php.
References getDiv().
Referenced by CodexHTMLForm\formatField(), and VFormHTMLForm\formatField().
HTMLFormField::hasVisibleOutput | ( | ) |
If this field has a user-visible output or not.
If not, it will not be rendered
Reimplemented in HTMLApiField, and HTMLHiddenField.
Definition at line 113 of file HTMLFormField.php.
Referenced by canDisplayErrors().
HTMLFormField::isDisabled | ( | $alldata | ) |
Test whether this field is supposed to be disabled, based on the values of the other form fields.
array | $alldata | The data collected from the form |
Definition at line 361 of file HTMLFormField.php.
References checkStateRecurse(), and isHidden().
HTMLFormField::isHelpInline | ( | ) |
Determine if the help text should be displayed inline.
Only applies to OOUI forms.
Definition at line 986 of file HTMLFormField.php.
Referenced by getOOUI(), and shouldInfuseOOUI().
HTMLFormField::isHidden | ( | $alldata | ) |
Test whether this field is supposed to be hidden, based on the values of the other form fields.
array | $alldata | The data collected from the form |
Definition at line 348 of file HTMLFormField.php.
References checkStateRecurse().
Referenced by isDisabled(), HTMLRestrictionsField\validate(), and validate().
|
protected |
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.
checkboxes.
Returns true if the request was posted and has a field for a CSRF token (wpEditToken), or has a form identifier (wpFormIdentifier).
WebRequest | $request |
Definition at line 473 of file HTMLFormField.php.
References MediaWiki\Request\WebRequest\getCheck(), and MediaWiki\Request\WebRequest\wasPosted().
Referenced by HTMLCheckField\loadDataFromRequest(), HTMLCheckMatrix\loadDataFromRequest(), and HTMLMultiSelectField\loadDataFromRequest().
HTMLFormField::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.
WebRequest | $request |
Reimplemented in HTMLAutoCompleteSelectField, HTMLCheckField, HTMLCheckMatrix, HTMLDateTimeField, HTMLExpiryField, HTMLFormFieldCloner, HTMLMultiSelectField, HTMLNamespacesMultiselectField, HTMLRestrictionsField, HTMLSelectAndOtherField, HTMLSelectOrOtherField, HTMLSizeFilterField, HTMLSubmitField, HTMLTagMultiselectField, HTMLTitlesMultiselectField, and HTMLUsersMultiselectField.
Definition at line 488 of file HTMLFormField.php.
References getDefault().
HTMLFormField::msg | ( | $key, | |
$params | |||
) |
Get a translated interface message.
This is a wrapper around $this->mParent->msg() if $this->mParent is set and wfMessage() otherwise.
Parameters are the same as wfMessage().
string | string[] | MessageSpecifier | $key | |
mixed | ...$params |
Definition at line 99 of file HTMLFormField.php.
References wfMessage().
Referenced by HTMLAutoCompleteSelectField\__construct(), HTMLDateTimeField\__construct(), HTMLMultiSelectField\__construct(), HTMLSelectAndOtherField\__construct(), Licenses\__construct(), HTMLEditTools\formatMsg(), HTMLSelectAndOtherField\getDefault(), HTMLSizeFilterField\getInputHTML(), HTMLFormFieldCloner\getInputHTMLForKey(), HTMLNamespacesMultiselectField\getInputOOUI(), HTMLTagMultiselectField\getInputOOUI(), HTMLTitlesMultiselectField\getInputOOUI(), HTMLUsersMultiselectField\getInputOOUI(), HTMLUserTextField\isValidIPRange(), HTMLSelectAndOtherField\loadDataFromRequest(), Licenses\makeLines(), Licenses\outputOption(), HTMLAutoCompleteSelectField\validate(), HTMLCheckMatrix\validate(), HTMLDateTimeField\validate(), HTMLFloatField\validate(), HTMLIntField\validate(), HTMLMultiSelectField\validate(), HTMLNamespacesMultiselectField\validate(), HTMLRadioField\validate(), HTMLRestrictionsField\validate(), HTMLSelectAndOtherField\validate(), HTMLSelectField\validate(), HTMLTagMultiselectField\validate(), HTMLTitlesMultiselectField\validate(), HTMLTitleTextField\validate(), HTMLUsersMultiselectField\validate(), HTMLUserTextField\validate(), validate(), and HTMLFormFieldCloner\validate().
HTMLFormField::needsJSForHtml5FormValidation | ( | ) |
Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.
Definition at line 1307 of file HTMLFormField.php.
|
protected |
Should this field have a label, or is there no input element with the appropriate id for the label to point to?
Reimplemented in HTMLButtonField, HTMLCheckField, HTMLFormFieldCloner, HTMLInfoField, HTMLMultiSelectField, HTMLRadioField, and HTMLSizeFilterField.
Definition at line 445 of file HTMLFormField.php.
|
protected |
Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML.
Also check for field existence here.
array | $params |
Definition at line 302 of file HTMLFormField.php.
References getNearestField(), and parseCondState().
Referenced by parseCondState(), and parseCondStateForClient().
|
protected |
Parse the cond-state array for client-side.
Definition at line 332 of file HTMLFormField.php.
References parseCondState().
Referenced by getDiv(), getHelpTextHtmlDiv(), getHelpTextHtmlTable(), getOOUI(), and getTableRow().
HTMLFormField::setShowEmptyLabel | ( | $show | ) |
Tell the field whether to generate a separate label element if its label is blank.
bool | $show | Set to false to not generate a label. |
Definition at line 458 of file HTMLFormField.php.
Referenced by HTMLButtonField\__construct().
|
protected |
Whether the field should be automatically infused.
Note that all OOUI HTMLForm fields are infusable (you can call OO.ui.infuse() on them), but not all are infused by default, since there is no benefit in doing it e.g. for buttons and it's a small performance hit on page load.
Reimplemented in HTMLCheckMatrix, HTMLComboboxField, HTMLDateTimeField, HTMLExpiryField, HTMLFileField, HTMLNamespacesMultiselectField, HTMLSelectField, HTMLSelectNamespace, HTMLSelectOrOtherField, HTMLTagFilter, HTMLTagMultiselectField, HTMLTitlesMultiselectField, HTMLTitleTextField, HTMLToggleSwitchField, HTMLUsersMultiselectField, and HTMLUserTextField.
Definition at line 814 of file HTMLFormField.php.
References isHelpInline().
Referenced by getOOUI().
HTMLFormField::skipLoadData | ( | $request | ) |
Skip this field when collecting data.
WebRequest | $request |
Reimplemented in HTMLSubmitField.
Definition at line 1296 of file HTMLFormField.php.
HTMLFormField::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
mixed | $value | The value the field was submitted with |
array | $alldata | The data collected from the form |
Reimplemented in HTMLAutoCompleteSelectField, HTMLButtonField, HTMLCheckMatrix, HTMLDateTimeField, HTMLFloatField, HTMLIntField, HTMLMultiSelectField, HTMLNamespacesMultiselectField, HTMLRadioField, HTMLRestrictionsField, HTMLSelectAndOtherField, HTMLSelectField, HTMLSelectLimitField, HTMLTagMultiselectField, HTMLTimezoneField, HTMLTitlesMultiselectField, HTMLTitleTextField, HTMLUsersMultiselectField, HTMLUserTextField, EditWatchlistCheckboxSeriesField, and HTMLFormFieldCloner.
Definition at line 395 of file HTMLFormField.php.
References isHidden(), msg(), and true.
Referenced by EditWatchlistCheckboxSeriesField\validate().
|
protected |
Validate the cond-state params, the existence check of fields should be done later.
array | $params |
Definition at line 207 of file HTMLFormField.php.
References validateCondState().
Referenced by __construct(), and validateCondState().
|
protected |
Definition at line 25 of file HTMLFormField.php.
Referenced by HTMLAutoCompleteSelectField\getInputHTML(), HTMLFileField\getInputHTML(), HTMLSelectAndOtherField\getInputHTML(), HTMLSelectOrOtherField\getInputHTML(), HTMLTextField\getInputHTML(), HTMLButtonField\getInputOOUI(), HTMLComboboxField\getInputOOUI(), HTMLFileField\getInputOOUI(), HTMLTextField\getInputOOUI(), and HTMLToggleSwitchField\getInputOOUI().
|
protected |
Array to hold params for 'hide-if' or 'disable-if' statements.
Definition at line 39 of file HTMLFormField.php.
|
protected |
Definition at line 40 of file HTMLFormField.php.
|
protected |
Definition at line 28 of file HTMLFormField.php.
|
protected |
Definition at line 22 of file HTMLFormField.php.
Referenced by HTMLFileField\getInputHTML(), HTMLTextField\getInputHTML(), HTMLNamespacesMultiselectField\getInputOOUI(), and HTMLTitlesMultiselectField\getInputOOUI().
|
protected |
Definition at line 20 of file HTMLFormField.php.
|
protected |
Definition at line 27 of file HTMLFormField.php.
|
protected |
Definition at line 24 of file HTMLFormField.php.
Referenced by HTMLButtonField\getInputHTML(), HTMLFileField\getInputHTML(), HTMLSelectAndOtherField\getInputHTML(), HTMLSelectOrOtherField\getInputHTML(), HTMLTextField\getInputHTML(), Licenses\getInputHTML(), HTMLButtonField\getInputOOUI(), HTMLDateTimeField\getInputOOUI(), HTMLNamespacesMultiselectField\getInputOOUI(), HTMLTitlesMultiselectField\getInputOOUI(), and HTMLToggleSwitchField\getInputOOUI().
|
protected |
Definition at line 23 of file HTMLFormField.php.
|
protected |
Definition at line 21 of file HTMLFormField.php.
Referenced by HTMLButtonField\getInputHTML(), HTMLFileField\getInputHTML(), HTMLTextField\getInputHTML(), Licenses\getInputHTML(), HTMLDateTimeField\getInputOOUI(), HTMLNamespacesMultiselectField\getInputOOUI(), HTMLSelectAndOtherField\getInputOOUI(), HTMLSelectOrOtherField\getInputOOUI(), HTMLTagMultiselectField\getInputOOUI(), HTMLTitlesMultiselectField\getInputOOUI(), HTMLToggleSwitchField\getInputOOUI(), and HTMLUsersMultiselectField\getInputOOUI().
|
protected |
Definition at line 34 of file HTMLFormField.php.
Referenced by HTMLSelectAndOtherField\__construct(), and HTMLSelectOrOtherField\__construct().
|
protected |
Definition at line 35 of file HTMLFormField.php.
array array [] HTMLFormField::$mParams |
Definition at line 16 of file HTMLFormField.php.
Referenced by HTMLExpiryField\getFieldByType().
HTMLForm null HTMLFormField::$mParent |
Definition at line 51 of file HTMLFormField.php.
|
protected |
If true will generate an empty div element with no label.
Definition at line 46 of file HTMLFormField.php.
|
protected |
Definition at line 26 of file HTMLFormField.php.