MediaWiki master
|
Wrapper for Html::namespaceSelector to use in HTMLForm. More...
Inherits MediaWiki\HTMLForm\HTMLFormField.
Inherited by MediaWiki\HTMLForm\Field\HTMLNamespacesMultiselectField, and MediaWiki\HTMLForm\Field\HTMLSelectNamespaceWithButton.
Public Member Functions | |||||||
__construct ( $params) | |||||||
getInputCodex ( $value, $hasErrors) | |||||||
Same as getInputHTML, but for Codex.This is called by CodexHTMLForm.If not overridden, falls back to getInputHTML.
| |||||||
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.
| |||||||
getInputOOUI ( $value) | |||||||
Same as getInputHTML, but returns an OOUI object.Defaults to false, which getOOUI will interpret as "use the HTML version"
| |||||||
Public Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField | |||||||
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. | |||||||
getCodex ( $value) | |||||||
Get the Codex version of the div. | |||||||
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, $cssClasses=[]) | |||||||
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. | |||||||
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. | |||||||
Protected Member Functions | |
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.
| |
shouldInfuseOOUI () | |
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.
| |
Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField | |
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. | |
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. | |
validateCondState ( $params) | |
Validate the cond-state params, the existence check of fields should be done later. | |
Protected Attributes | |
string null | $mAllValue |
int[] null | $mInclude |
bool | $mUserLang |
Protected Attributes inherited from MediaWiki\HTMLForm\HTMLFormField | |
string | $mClass = '' |
array | $mCondState = [] |
Array to hold params for 'hide-if' or 'disable-if' statements. | |
array | $mCondStateClass = [] |
mixed | $mDefault |
string | $mDir |
string false | $mHelpClass = false |
string | $mID |
string | $mLabel |
String label, as HTML. | |
string | $mName |
array null false | $mOptions = false |
bool | $mOptionsLabelsNotFromMessage = false |
bool | $mShowEmptyLabels = true |
If true will generate an empty div element with no label. | |
string | $mVFormClass = '' |
Additional Inherited Members | |
Static Public Member Functions inherited from MediaWiki\HTMLForm\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 MediaWiki\HTMLForm\HTMLFormField | |
array array[] | $mParams |
HTMLForm null | $mParent |
Static Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField | |
static | formatErrors ( $errors) |
Formats one or more errors as accepted by field validation-callback. | |
Wrapper for Html::namespaceSelector to use in HTMLForm.
Definition at line 13 of file HTMLSelectNamespace.php.
MediaWiki\HTMLForm\Field\HTMLSelectNamespace::__construct | ( | $params | ) |
Reimplemented from MediaWiki\HTMLForm\HTMLFormField.
Reimplemented in MediaWiki\HTMLForm\Field\HTMLSelectNamespaceWithButton.
Definition at line 26 of file HTMLSelectNamespace.php.
References $params.
MediaWiki\HTMLForm\Field\HTMLSelectNamespace::getInputCodex | ( | $value, | |
$hasErrors ) |
Same as getInputHTML, but for Codex.This is called by CodexHTMLForm.If not overridden, falls back to getInputHTML.
string | $value | The value to set the input to |
bool | $hasErrors | Whether there are validation errors. If set to true, this method should apply a CSS class for the error status (e.g. cdx-text-input–status-error) if the component used supports that. |
Reimplemented from MediaWiki\HTMLForm\HTMLFormField.
Reimplemented in MediaWiki\HTMLForm\Field\HTMLNamespacesMultiselectField.
Definition at line 79 of file HTMLSelectNamespace.php.
References MediaWiki\HTMLForm\Field\HTMLSelectNamespace\$mAllValue, and MediaWiki\HTMLForm\Field\HTMLSelectNamespace\$mUserLang.
MediaWiki\HTMLForm\Field\HTMLSelectNamespace::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.
mixed | $value | The value to set the input to; eg a default text for a text input. |
Reimplemented from MediaWiki\HTMLForm\HTMLFormField.
Reimplemented in MediaWiki\HTMLForm\Field\HTMLNamespacesMultiselectField, and MediaWiki\HTMLForm\Field\HTMLSelectNamespaceWithButton.
Definition at line 45 of file HTMLSelectNamespace.php.
MediaWiki\HTMLForm\Field\HTMLSelectNamespace::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 from MediaWiki\HTMLForm\HTMLFormField.
Reimplemented in MediaWiki\HTMLForm\Field\HTMLNamespacesMultiselectField.
Definition at line 64 of file HTMLSelectNamespace.php.
|
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 from MediaWiki\HTMLForm\HTMLFormField.
Reimplemented in MediaWiki\HTMLForm\Field\HTMLNamespacesMultiselectField.
Definition at line 94 of file HTMLSelectNamespace.php.
|
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 from MediaWiki\HTMLForm\HTMLFormField.
Reimplemented in MediaWiki\HTMLForm\Field\HTMLNamespacesMultiselectField.
Definition at line 103 of file HTMLSelectNamespace.php.
|
protected |
Definition at line 16 of file HTMLSelectNamespace.php.
Referenced by MediaWiki\HTMLForm\Field\HTMLSelectNamespace\getInputCodex().
|
protected |
Definition at line 20 of file HTMLSelectNamespace.php.
|
protected |
Definition at line 18 of file HTMLSelectNamespace.php.
Referenced by MediaWiki\HTMLForm\Field\HTMLSelectNamespace\getInputCodex().