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. More... | |
| skipLoadData ( $request) | |
| Skip this field when collecting data. More... | |
 Public Member Functions inherited from HTMLButtonField | |
| __construct ( $info) | |
| Initialise the object. More... | |
| getInputHTML ( $value) | |
| This function must be implemented to return the HTML to generate the input object itself. More... | |
| getInputOOUI ( $value) | |
| Get the OOUI widget for this field. More... | |
| validate ( $value, $alldata) | |
| Button cannot be invalid. More... | |
| 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. 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... | |
| getLabel () | |
| getLabelHtml ( $cellAttributes=[]) | |
| 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, 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... | |
| 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... | |
| msg () | |
| 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... | |
Protected Attributes | |
| $buttonType = 'submit' | |
| $mFlags = [ 'primary', 'progressive' ] | |
| Protected Attributes inherited from HTMLButtonField | |
| $buttonLabel = null | |
| $buttonType = 'button' | |
| $mFlags = [] | |
| $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. 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 | |
| $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? 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... | |
| 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... | |
| 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... | |
| shouldInfuseOOUI () | |
| Whether the field should be automatically infused. More... | |
| Static Protected Member Functions inherited from HTMLFormField | |
| static | formatErrors ( $errors) |
| Formats one or more errors as accepted by field validation-callback. More... | |
Detailed Description
Add a submit button inline in the form (as opposed to HTMLForm::addButton(), which will add it at the end).
Definition at line 7 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.
- Parameters
-
WebRequest $request
- Returns
- string The value
Reimplemented from HTMLFormField.
Definition at line 16 of file HTMLSubmitField.php.
References $request.
◆ skipLoadData()
| HTMLSubmitField::skipLoadData | ( | $request | ) |
Skip this field when collecting data.
- Parameters
-
WebRequest $request
- Returns
- bool
- Since
- 1.27
Reimplemented from HTMLFormField.
Definition at line 12 of file HTMLSubmitField.php.
References $request.
Member Data Documentation
◆ $buttonType
|
protected |
Definition at line 8 of file HTMLSubmitField.php.
◆ $mFlags
|
protected |
Definition at line 10 of file HTMLSubmitField.php.
The documentation for this class was generated from the following file:
- includes/htmlform/fields/HTMLSubmitField.php
