MediaWiki REL1_35
HTMLSubmitField Class Reference

Add a submit button inline in the form (as opposed to HTMLForm::addButton(), which will add it at the end). More...

Inheritance diagram for HTMLSubmitField:
Collaboration diagram for HTMLSubmitField:

Public Member Functions

 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.
 
 skipLoadData ( $request)
 Skip this field when collecting data.
 
- Public Member Functions inherited from HTMLButtonField
 __construct ( $info)
 Initialise the object.
 
 getInputHTML ( $value)
 This function must be implemented to return the HTML to generate the input object itself.
 
 getInputOOUI ( $value)
 Get the OOUI widget for this field.
 
 validate ( $value, $alldata)
 Button cannot be invalid Stable to override.
 
- Public Member Functions inherited from 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)
 Stable to override.
 
 getAttributes (array $list)
 Returns the given attributes from the parameters Stable to override.
 
 getDefault ()
 Stable to override.
 
 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 Stable to override.
 
 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.
 
 getLabel ()
 Stable to override.
 
 getLabelHtml ( $cellAttributes=[])
 Stable to override.
 
 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 ( $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.
 

Protected Attributes

 $buttonType = 'submit'
 
 $mFlags = [ 'primary', 'progressive' ]
 
- Protected Attributes inherited from HTMLButtonField
 $buttonLabel = null
 
 $buttonType = 'button'
 
array $mFlags = []
 Flags to add to OOUI Button widget.
 
 $mFormnovalidate = false
 
- 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 = ''
 

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
array array[] $mParams
 
HTMLForm null $mParent
 
- Protected Member Functions inherited from HTMLButtonField
 needsLabel ()
 Should this field have a label, or is there no input element with the appropriate id for the label to point to? Stable to override.
Returns
bool True to output a label, false to suppress
Stable to override
 
- Protected Member Functions inherited from HTMLFormField
 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.
 
 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.
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback.
 

Detailed Description

Add a submit button inline in the form (as opposed to HTMLForm::addButton(), which will add it at the end).

Stable to extend

Definition at line 9 of file HTMLSubmitField.php.

Member Function Documentation

◆ loadDataFromRequest()

HTMLSubmitField::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.

Stable to override

Parameters
WebRequest$request
Returns
mixed The value

Reimplemented from HTMLFormField.

Definition at line 18 of file HTMLSubmitField.php.

◆ skipLoadData()

HTMLSubmitField::skipLoadData (   $request)

Skip this field when collecting data.

Stable to override

Parameters
WebRequest$request
Returns
bool
Since
1.27

Reimplemented from HTMLFormField.

Definition at line 14 of file HTMLSubmitField.php.

Member Data Documentation

◆ $buttonType

HTMLSubmitField::$buttonType = 'submit'
protected

Definition at line 10 of file HTMLSubmitField.php.

◆ $mFlags

HTMLSubmitField::$mFlags = [ 'primary', 'progressive' ]
protected

Definition at line 12 of file HTMLSubmitField.php.


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