MediaWiki  master
HTMLTagFilter Class Reference

Wrapper for ChangeTags::buildTagFilterSelector to use in HTMLForm. More...

Inheritance diagram for HTMLTagFilter:
Collaboration diagram for HTMLTagFilter:

Public Member Functions

 getDiv ( $value)
 Get the complete div for the input, including help text, labels, and whatever. 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...
 
 getOOUI ( $value)
 Get the OOUI version of the div. More...
 
 getTableRow ( $value)
 Get the complete table row for the input, including help text, labels, and whatever. More...
 
- 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 ()
 
 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...
 
 getLabel ()
 
 getLabelHtml ( $cellAttributes=[])
 
 getName ()
 Get the field name that will be used for submission. 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...
 
 getTooltipAndAccessKey ()
 Returns the attributes required for the tooltip and accesskey, for Html::element() etc. More...
 
 getTooltipAndAccessKeyOOUI ()
 Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config. 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...
 
 isDisabled ( $alldata)
 Test whether this field is supposed to be disabled, based on the values of the other form fields. More...
 
 isHelpInline ()
 Determine if the help text should be displayed inline. 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 ( $key,... $params)
 Get a translated interface message. More...
 
 needsJSForHtml5FormValidation ()
 Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly. 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

 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 
- Protected Member Functions inherited from HTMLFormField
 checkStateRecurse (array $alldata, array $params)
 Helper function for isHidden and isDisabled to handle recursive data structures. More...
 
 getClassName ()
 Gets the non namespaced class name. More...
 
 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...
 
 getNearestField ( $name, $backCompat=false)
 Get the closest field matching a given name. More...
 
 getNearestFieldByName ( $alldata, $name, $asDisplay=false)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 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. 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...
 
 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. More...
 
 parseCondStateForClient ()
 Parse the cond-state array for client-side. More...
 
 validateCondState ( $params)
 Validate the cond-state params, the existence check of fields should be done later. More...
 

Protected Attributes

 $tagFilter
 
- Protected Attributes inherited from HTMLFormField
 $mClass = ''
 
array $mCondState = []
 Array to hold params for 'hide-if' or 'disable-if' statements. More...
 
 $mCondStateClass = []
 
 $mDefault
 
 $mDir
 
 $mFilterCallback
 
 $mHelpClass = false
 
 $mID
 
 $mLabel
 
 $mName
 
array bool null $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 
 $mVFormClass = ''
 

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
array array[] $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...
 

Detailed Description

Wrapper for ChangeTags::buildTagFilterSelector to use in HTMLForm.

Stability: stable
to extend

Definition at line 7 of file HTMLTagFilter.php.

Member Function Documentation

◆ getDiv()

HTMLTagFilter::getDiv (   $value)

Get the complete div for the input, including help text, labels, and whatever.

Stability: stable
to override
Since
1.20
Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML table row.

Reimplemented from HTMLFormField.

Definition at line 19 of file HTMLTagFilter.php.

References ChangeTags\buildTagFilterSelector().

◆ getInputHTML()

HTMLTagFilter::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
mixed$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 37 of file HTMLTagFilter.php.

◆ getInputOOUI()

HTMLTagFilter::getInputOOUI (   $value)

Same as getInputHTML, but returns an OOUI object.

Defaults to false, which getOOUI will interpret as "use the HTML version"

Stability: stable
to override
Parameters
string$value
Returns
OOUI\Widget|string|false

Reimplemented from HTMLFormField.

Definition at line 45 of file HTMLTagFilter.php.

◆ getOOUI()

HTMLTagFilter::getOOUI (   $value)

Get the OOUI version of the div.

Falls back to getDiv by default.

Stability: stable
to override
Since
1.26
Parameters
string$valueThe value to set the input to.
Returns
OOUI\FieldLayout

Reimplemented from HTMLFormField.

Definition at line 28 of file HTMLTagFilter.php.

References ChangeTags\buildTagFilterSelector().

◆ getTableRow()

HTMLTagFilter::getTableRow (   $value)

Get the complete table row for the input, including help text, labels, and whatever.

Stability: stable
to override
Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML table row.

Reimplemented from HTMLFormField.

Definition at line 10 of file HTMLTagFilter.php.

References ChangeTags\buildTagFilterSelector().

◆ shouldInfuseOOUI()

HTMLTagFilter::shouldInfuseOOUI ( )
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.

Stability: stable
to override
Returns
bool

Reimplemented from HTMLFormField.

Definition at line 53 of file HTMLTagFilter.php.

Member Data Documentation

◆ $tagFilter

HTMLTagFilter::$tagFilter
protected

Definition at line 8 of file HTMLTagFilter.php.


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