4 * HTML form generation and submission handling.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
24 use Wikimedia\ObjectFactory
;
27 * Object handling generic submission, CSRF protection, layout and
28 * other logic for UI forms. in a reusable manner.
30 * In order to generate the form, the HTMLForm object takes an array
31 * structure detailing the form fields available. Each element of the
32 * array is a basic property-list, including the type of field, the
33 * label it is to be given in the form, callbacks for validation and
34 * 'filtering', and other pertinent information.
36 * Field types are implemented as subclasses of the generic HTMLFormField
37 * object, and typically implement at least getInputHTML, which generates
38 * the HTML for the input field to be placed in the table.
40 * You can find extensive documentation on the www.mediawiki.org wiki:
41 * - https://www.mediawiki.org/wiki/HTMLForm
42 * - https://www.mediawiki.org/wiki/HTMLForm/tutorial
44 * The constructor input is an associative array of $fieldname => $info,
45 * where $info is an Associative Array with any of the following:
47 * 'class' -- the subclass of HTMLFormField that will be used
48 * to create the object. *NOT* the CSS class!
49 * 'type' -- roughly translates into the <select> type attribute.
50 * if 'class' is not specified, this is used as a map
51 * through HTMLForm::$typeMappings to get the class name.
52 * 'default' -- default value when the form is displayed
53 * 'nodata' -- if set (to any value, which casts to true), the data
54 * for this field will not be loaded from the actual request. Instead,
55 * always the default data is set as the value of this field.
56 * 'id' -- HTML id attribute
57 * 'cssclass' -- CSS class
58 * 'csshelpclass' -- CSS class used to style help text
59 * 'dir' -- Direction of the element.
60 * 'options' -- associative array mapping labels to values.
61 * Some field types support multi-level arrays.
62 * 'options-messages' -- associative array mapping message keys to values.
63 * Some field types support multi-level arrays.
64 * 'options-message' -- message key or object to be parsed to extract the list of
65 * options (like 'ipbreason-dropdown').
66 * 'label-message' -- message key or object for a message to use as the label.
67 * can be an array of msg key and then parameters to
69 * 'label' -- alternatively, a raw text message. Overridden by
71 * 'help' -- message text for a message to use as a help text.
72 * 'help-message' -- message key or object for a message to use as a help text.
73 * can be an array of msg key and then parameters to
75 * Overwrites 'help-messages' and 'help'.
76 * 'help-messages' -- array of message keys/objects. As above, each item can
77 * be an array of msg key and then parameters.
79 * 'notice' -- message text for a message to use as a notice in the field.
80 * Currently used by OOUI form fields only.
81 * 'notice-messages' -- array of message keys/objects to use for notice.
83 * 'notice-message' -- message key or object to use as a notice.
84 * 'required' -- passed through to the object, indicating that it
85 * is a required field.
86 * 'size' -- the length of text fields
87 * 'filter-callback' -- a function name to give you the chance to
88 * massage the inputted value before it's processed.
89 * @see HTMLFormField::filter()
90 * 'validation-callback' -- a function name to give you the chance
91 * to impose extra validation on the field input.
92 * @see HTMLFormField::validate()
93 * 'name' -- By default, the 'name' attribute of the input field
94 * is "wp{$fieldname}". If you want a different name
95 * (eg one without the "wp" prefix), specify it here and
96 * it will be used without modification.
97 * 'hide-if' -- expression given as an array stating when the field
98 * should be hidden. The first array value has to be the
99 * expression's logic operator. Supported expressions:
101 * [ 'NOT', array $expression ]
102 * To hide a field if a given expression is not true.
104 * [ '===', string $fieldName, string $value ]
105 * To hide a field if another field identified by
106 * $field has the value $value.
108 * [ '!==', string $fieldName, string $value ]
109 * Same as [ 'NOT', [ '===', $fieldName, $value ]
110 * 'OR', 'AND', 'NOR', 'NAND'
111 * [ 'XXX', array $expression1, ..., array $expressionN ]
112 * To hide a field if one or more (OR), all (AND),
113 * neither (NOR) or not all (NAND) given expressions
114 * are evaluated as true.
115 * The expressions will be given to a JavaScript frontend
116 * module which will continually update the field's
119 * Since 1.20, you can chain mutators to ease the form generation:
122 * $form = new HTMLForm( $someFields );
123 * $form->setMethod( 'get' )
124 * ->setWrapperLegendMsg( 'message-key' )
126 * ->displayForm( '' );
128 * Note that you will have prepareForm and displayForm at the end. Other
129 * methods call done after that would simply not be part of the form :(
131 * @todo Document 'section' / 'subsection' stuff
133 class HTMLForm
extends ContextSource
{
134 // A mapping of 'type' inputs onto standard HTMLFormField subclasses
135 public static $typeMappings = [
136 'api' => HTMLApiField
::class,
137 'text' => HTMLTextField
::class,
138 'textwithbutton' => HTMLTextFieldWithButton
::class,
139 'textarea' => HTMLTextAreaField
::class,
140 'select' => HTMLSelectField
::class,
141 'combobox' => HTMLComboboxField
::class,
142 'radio' => HTMLRadioField
::class,
143 'multiselect' => HTMLMultiSelectField
::class,
144 'limitselect' => HTMLSelectLimitField
::class,
145 'check' => HTMLCheckField
::class,
146 'toggle' => HTMLCheckField
::class,
147 'int' => HTMLIntField
::class,
148 'float' => HTMLFloatField
::class,
149 'info' => HTMLInfoField
::class,
150 'selectorother' => HTMLSelectOrOtherField
::class,
151 'selectandother' => HTMLSelectAndOtherField
::class,
152 'namespaceselect' => HTMLSelectNamespace
::class,
153 'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton
::class,
154 'tagfilter' => HTMLTagFilter
::class,
155 'sizefilter' => HTMLSizeFilterField
::class,
156 'submit' => HTMLSubmitField
::class,
157 'hidden' => HTMLHiddenField
::class,
158 'edittools' => HTMLEditTools
::class,
159 'checkmatrix' => HTMLCheckMatrix
::class,
160 'cloner' => HTMLFormFieldCloner
::class,
161 'autocompleteselect' => HTMLAutoCompleteSelectField
::class,
162 'date' => HTMLDateTimeField
::class,
163 'time' => HTMLDateTimeField
::class,
164 'datetime' => HTMLDateTimeField
::class,
165 // HTMLTextField will output the correct type="" attribute automagically.
166 // There are about four zillion other HTML5 input types, like range, but
167 // we don't use those at the moment, so no point in adding all of them.
168 'email' => HTMLTextField
::class,
169 'password' => HTMLTextField
::class,
170 'url' => HTMLTextField
::class,
171 'title' => HTMLTitleTextField
::class,
172 'user' => HTMLUserTextField
::class,
173 'usersmultiselect' => HTMLUsersMultiselectField
::class,
178 protected $mMessagePrefix;
180 /** @var HTMLFormField[] */
181 protected $mFlatFields;
183 protected $mFieldTree;
184 protected $mShowReset = false;
185 protected $mShowSubmit = true;
186 protected $mSubmitFlags = [ 'primary', 'progressive' ];
187 protected $mShowCancel = false;
188 protected $mCancelTarget;
190 protected $mSubmitCallback;
191 protected $mValidationErrorMessage;
193 protected $mPre = '';
194 protected $mHeader = '';
195 protected $mFooter = '';
196 protected $mSectionHeaders = [];
197 protected $mSectionFooters = [];
198 protected $mPost = '';
201 protected $mTableId = '';
203 protected $mSubmitID;
204 protected $mSubmitName;
205 protected $mSubmitText;
206 protected $mSubmitTooltip;
208 protected $mFormIdentifier;
210 protected $mMethod = 'post';
211 protected $mWasSubmitted = false;
214 * Form action URL. false means we will use the URL to set Title
218 protected $mAction = false;
221 * Form attribute autocomplete. A typical value is "off". null does not set the attribute
225 protected $mAutocomplete = null;
227 protected $mUseMultipart = false;
228 protected $mHiddenFields = [];
229 protected $mButtons = [];
231 protected $mWrapperLegend = false;
234 * Salt for the edit token.
237 protected $mTokenSalt = '';
240 * If true, sections that contain both fields and subsections will
241 * render their subsections before their fields.
243 * Subclasses may set this to false to render subsections after fields
246 protected $mSubSectionBeforeFields = true;
249 * Format in which to display form. For viable options,
250 * @see $availableDisplayFormats
253 protected $displayFormat = 'table';
256 * Available formats in which to display the form
259 protected $availableDisplayFormats = [
267 * Available formats in which to display the form
270 protected $availableSubclassDisplayFormats = [
276 * Construct a HTMLForm object for given display type. May return a HTMLForm subclass.
278 * @param string $displayFormat
279 * @param mixed $arguments,... Additional arguments to pass to the constructor.
282 public static function factory( $displayFormat/*, $arguments...*/ ) {
283 $arguments = func_get_args();
284 array_shift( $arguments );
286 switch ( $displayFormat ) {
288 return ObjectFactory
::constructClassInstance( VFormHTMLForm
::class, $arguments );
290 return ObjectFactory
::constructClassInstance( OOUIHTMLForm
::class, $arguments );
292 /** @var HTMLForm $form */
293 $form = ObjectFactory
::constructClassInstance( self
::class, $arguments );
294 $form->setDisplayFormat( $displayFormat );
300 * Build a new HTMLForm from an array of field attributes
302 * @param array $descriptor Array of Field constructs, as described above
303 * @param IContextSource $context Available since 1.18, will become compulsory in 1.18.
304 * Obviates the need to call $form->setTitle()
305 * @param string $messagePrefix A prefix to go in front of default messages
307 public function __construct( $descriptor, /*IContextSource*/ $context = null,
310 if ( $context instanceof IContextSource
) {
311 $this->setContext( $context );
312 $this->mTitle
= false; // We don't need them to set a title
313 $this->mMessagePrefix
= $messagePrefix;
314 } elseif ( $context === null && $messagePrefix !== '' ) {
315 $this->mMessagePrefix
= $messagePrefix;
316 } elseif ( is_string( $context ) && $messagePrefix === '' ) {
318 // it's actually $messagePrefix
319 $this->mMessagePrefix
= $context;
322 // Evil hack for mobile :(
324 !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
325 && $this->displayFormat
=== 'table'
327 $this->displayFormat
= 'div';
330 // Expand out into a tree.
331 $loadedDescriptor = [];
332 $this->mFlatFields
= [];
334 foreach ( $descriptor as $fieldname => $info ) {
335 $section = isset( $info['section'] )
339 if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
340 $this->mUseMultipart
= true;
343 $field = static::loadInputFromParameters( $fieldname, $info, $this );
345 $setSection =& $loadedDescriptor;
347 $sectionParts = explode( '/', $section );
349 while ( count( $sectionParts ) ) {
350 $newName = array_shift( $sectionParts );
352 if ( !isset( $setSection[$newName] ) ) {
353 $setSection[$newName] = [];
356 $setSection =& $setSection[$newName];
360 $setSection[$fieldname] = $field;
361 $this->mFlatFields
[$fieldname] = $field;
364 $this->mFieldTree
= $loadedDescriptor;
368 * @param string $fieldname
371 public function hasField( $fieldname ) {
372 return isset( $this->mFlatFields
[$fieldname] );
376 * @param string $fieldname
377 * @return HTMLFormField
378 * @throws DomainException on invalid field name
380 public function getField( $fieldname ) {
381 if ( !$this->hasField( $fieldname ) ) {
382 throw new DomainException( __METHOD__
. ': no field named ' . $fieldname );
384 return $this->mFlatFields
[$fieldname];
388 * Set format in which to display the form
390 * @param string $format The name of the format to use, must be one of
391 * $this->availableDisplayFormats
393 * @throws MWException
395 * @return HTMLForm $this for chaining calls (since 1.20)
397 public function setDisplayFormat( $format ) {
399 in_array( $format, $this->availableSubclassDisplayFormats
, true ) ||
400 in_array( $this->displayFormat
, $this->availableSubclassDisplayFormats
, true )
402 throw new MWException( 'Cannot change display format after creation, ' .
403 'use HTMLForm::factory() instead' );
406 if ( !in_array( $format, $this->availableDisplayFormats
, true ) ) {
407 throw new MWException( 'Display format must be one of ' .
410 $this->availableDisplayFormats
,
411 $this->availableSubclassDisplayFormats
417 // Evil hack for mobile :(
418 if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
422 $this->displayFormat
= $format;
428 * Getter for displayFormat
432 public function getDisplayFormat() {
433 return $this->displayFormat
;
437 * Test if displayFormat is 'vform'
439 * @deprecated since 1.25
442 public function isVForm() {
443 wfDeprecated( __METHOD__
, '1.25' );
448 * Get the HTMLFormField subclass for this descriptor.
450 * The descriptor can be passed either 'class' which is the name of
451 * a HTMLFormField subclass, or a shorter 'type' which is an alias.
452 * This makes sure the 'class' is always set, and also is returned by
453 * this function for ease.
457 * @param string $fieldname Name of the field
458 * @param array &$descriptor Input Descriptor, as described above
460 * @throws MWException
461 * @return string Name of a HTMLFormField subclass
463 public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
464 if ( isset( $descriptor['class'] ) ) {
465 $class = $descriptor['class'];
466 } elseif ( isset( $descriptor['type'] ) ) {
467 $class = static::$typeMappings[$descriptor['type']];
468 $descriptor['class'] = $class;
474 throw new MWException( "Descriptor with no class for $fieldname: "
475 . print_r( $descriptor, true ) );
482 * Initialise a new Object for the field
484 * @param string $fieldname Name of the field
485 * @param array $descriptor Input Descriptor, as described above
486 * @param HTMLForm|null $parent Parent instance of HTMLForm
488 * @throws MWException
489 * @return HTMLFormField Instance of a subclass of HTMLFormField
491 public static function loadInputFromParameters( $fieldname, $descriptor,
492 HTMLForm
$parent = null
494 $class = static::getClassFromDescriptor( $fieldname, $descriptor );
496 $descriptor['fieldname'] = $fieldname;
498 $descriptor['parent'] = $parent;
501 # @todo This will throw a fatal error whenever someone try to use
502 # 'class' to feed a CSS class instead of 'cssclass'. Would be
503 # great to avoid the fatal error and show a nice error.
504 return new $class( $descriptor );
508 * Prepare form for submission.
510 * @attention When doing method chaining, that should be the very last
511 * method call before displayForm().
513 * @throws MWException
514 * @return HTMLForm $this for chaining calls (since 1.20)
516 public function prepareForm() {
517 # Check if we have the info we need
518 if ( !$this->mTitle
instanceof Title
&& $this->mTitle
!== false ) {
519 throw new MWException( 'You must call setTitle() on an HTMLForm' );
522 # Load data from the request.
524 $this->mFormIdentifier
=== null ||
525 $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
529 $this->mFieldData
= [];
536 * Try submitting, with edit token check first
537 * @return Status|bool
539 public function tryAuthorizedSubmit() {
543 if ( $this->mFormIdentifier
=== null ) {
546 $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
;
550 if ( $this->getMethod() !== 'post' ) {
551 $tokenOkay = true; // no session check needed
552 } elseif ( $this->getRequest()->wasPosted() ) {
553 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
554 if ( $this->getUser()->isLoggedIn() ||
$editToken !== null ) {
555 // Session tokens for logged-out users have no security value.
556 // However, if the user gave one, check it in order to give a nice
557 // "session expired" error instead of "permission denied" or such.
558 $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt
);
564 if ( $tokenOkay && $identOkay ) {
565 $this->mWasSubmitted
= true;
566 $result = $this->trySubmit();
573 * The here's-one-I-made-earlier option: do the submission if
574 * posted, or display the form with or without funky validation
576 * @return bool|Status Whether submission was successful.
578 public function show() {
579 $this->prepareForm();
581 $result = $this->tryAuthorizedSubmit();
582 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ) {
586 $this->displayForm( $result );
592 * Same as self::show with the difference, that the form will be
593 * added to the output, no matter, if the validation was good or not.
594 * @return bool|Status Whether submission was successful.
596 public function showAlways() {
597 $this->prepareForm();
599 $result = $this->tryAuthorizedSubmit();
601 $this->displayForm( $result );
607 * Validate all the fields, and call the submission callback
608 * function if everything is kosher.
609 * @throws MWException
610 * @return bool|string|array|Status
611 * - Bool true or a good Status object indicates success,
612 * - Bool false indicates no submission was attempted,
613 * - Anything else indicates failure. The value may be a fatal Status
614 * object, an HTML string, or an array of arrays (message keys and
615 * params) or strings (message keys)
617 public function trySubmit() {
619 $hoistedErrors = Status
::newGood();
620 if ( $this->mValidationErrorMessage
) {
621 foreach ( (array)$this->mValidationErrorMessage
as $error ) {
622 call_user_func_array( [ $hoistedErrors, 'fatal' ], $error );
625 $hoistedErrors->fatal( 'htmlform-invalid-input' );
628 $this->mWasSubmitted
= true;
630 # Check for cancelled submission
631 foreach ( $this->mFlatFields
as $fieldname => $field ) {
632 if ( !array_key_exists( $fieldname, $this->mFieldData
) ) {
635 if ( $field->cancelSubmit( $this->mFieldData
[$fieldname], $this->mFieldData
) ) {
636 $this->mWasSubmitted
= false;
641 # Check for validation
642 foreach ( $this->mFlatFields
as $fieldname => $field ) {
643 if ( !array_key_exists( $fieldname, $this->mFieldData
) ) {
646 if ( $field->isHidden( $this->mFieldData
) ) {
649 $res = $field->validate( $this->mFieldData
[$fieldname], $this->mFieldData
);
650 if ( $res !== true ) {
652 if ( $res !== false && !$field->canDisplayErrors() ) {
653 if ( is_string( $res ) ) {
654 $hoistedErrors->fatal( 'rawmessage', $res );
656 $hoistedErrors->fatal( $res );
663 return $hoistedErrors;
666 $callback = $this->mSubmitCallback
;
667 if ( !is_callable( $callback ) ) {
668 throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
669 'setSubmitCallback() to set one.' );
672 $data = $this->filterDataForSubmit( $this->mFieldData
);
674 $res = call_user_func( $callback, $data, $this );
675 if ( $res === false ) {
676 $this->mWasSubmitted
= false;
683 * Test whether the form was considered to have been submitted or not, i.e.
684 * whether the last call to tryAuthorizedSubmit or trySubmit returned
687 * This will return false until HTMLForm::tryAuthorizedSubmit or
688 * HTMLForm::trySubmit is called.
693 public function wasSubmitted() {
694 return $this->mWasSubmitted
;
698 * Set a callback to a function to do something with the form
699 * once it's been successfully validated.
701 * @param callable $cb The function will be passed the output from
702 * HTMLForm::filterDataForSubmit and this HTMLForm object, and must
703 * return as documented for HTMLForm::trySubmit
705 * @return HTMLForm $this for chaining calls (since 1.20)
707 public function setSubmitCallback( $cb ) {
708 $this->mSubmitCallback
= $cb;
714 * Set a message to display on a validation error.
716 * @param string|array $msg String or Array of valid inputs to wfMessage()
717 * (so each entry can be either a String or Array)
719 * @return HTMLForm $this for chaining calls (since 1.20)
721 public function setValidationErrorMessage( $msg ) {
722 $this->mValidationErrorMessage
= $msg;
728 * Set the introductory message, overwriting any existing message.
730 * @param string $msg Complete text of message to display
732 * @return HTMLForm $this for chaining calls (since 1.20)
734 public function setIntro( $msg ) {
735 $this->setPreText( $msg );
741 * Set the introductory message HTML, overwriting any existing message.
744 * @param string $msg Complete HTML of message to display
746 * @return HTMLForm $this for chaining calls (since 1.20)
748 public function setPreText( $msg ) {
755 * Add HTML to introductory message.
757 * @param string $msg Complete HTML of message to display
759 * @return HTMLForm $this for chaining calls (since 1.20)
761 public function addPreText( $msg ) {
768 * Add HTML to the header, inside the form.
770 * @param string $msg Additional HTML to display in header
771 * @param string|null $section The section to add the header to
773 * @return HTMLForm $this for chaining calls (since 1.20)
775 public function addHeaderText( $msg, $section = null ) {
776 if ( $section === null ) {
777 $this->mHeader
.= $msg;
779 if ( !isset( $this->mSectionHeaders
[$section] ) ) {
780 $this->mSectionHeaders
[$section] = '';
782 $this->mSectionHeaders
[$section] .= $msg;
789 * Set header text, inside the form.
792 * @param string $msg Complete HTML of header to display
793 * @param string|null $section The section to add the header to
795 * @return HTMLForm $this for chaining calls (since 1.20)
797 public function setHeaderText( $msg, $section = null ) {
798 if ( $section === null ) {
799 $this->mHeader
= $msg;
801 $this->mSectionHeaders
[$section] = $msg;
810 * @param string|null $section The section to get the header text for
812 * @return string HTML
814 public function getHeaderText( $section = null ) {
815 if ( $section === null ) {
816 return $this->mHeader
;
818 return isset( $this->mSectionHeaders
[$section] ) ?
$this->mSectionHeaders
[$section] : '';
823 * Add footer text, inside the form.
825 * @param string $msg Complete text of message to display
826 * @param string|null $section The section to add the footer text to
828 * @return HTMLForm $this for chaining calls (since 1.20)
830 public function addFooterText( $msg, $section = null ) {
831 if ( $section === null ) {
832 $this->mFooter
.= $msg;
834 if ( !isset( $this->mSectionFooters
[$section] ) ) {
835 $this->mSectionFooters
[$section] = '';
837 $this->mSectionFooters
[$section] .= $msg;
844 * Set footer text, inside the form.
847 * @param string $msg Complete text of message to display
848 * @param string|null $section The section to add the footer text to
850 * @return HTMLForm $this for chaining calls (since 1.20)
852 public function setFooterText( $msg, $section = null ) {
853 if ( $section === null ) {
854 $this->mFooter
= $msg;
856 $this->mSectionFooters
[$section] = $msg;
865 * @param string|null $section The section to get the footer text for
869 public function getFooterText( $section = null ) {
870 if ( $section === null ) {
871 return $this->mFooter
;
873 return isset( $this->mSectionFooters
[$section] ) ?
$this->mSectionFooters
[$section] : '';
878 * Add text to the end of the display.
880 * @param string $msg Complete text of message to display
882 * @return HTMLForm $this for chaining calls (since 1.20)
884 public function addPostText( $msg ) {
885 $this->mPost
.= $msg;
891 * Set text at the end of the display.
893 * @param string $msg Complete text of message to display
895 * @return HTMLForm $this for chaining calls (since 1.20)
897 public function setPostText( $msg ) {
904 * Add a hidden field to the output
906 * @param string $name Field name. This will be used exactly as entered
907 * @param string $value Field value
908 * @param array $attribs
910 * @return HTMLForm $this for chaining calls (since 1.20)
912 public function addHiddenField( $name, $value, array $attribs = [] ) {
913 $attribs +
= [ 'name' => $name ];
914 $this->mHiddenFields
[] = [ $value, $attribs ];
920 * Add an array of hidden fields to the output
924 * @param array $fields Associative array of fields to add;
925 * mapping names to their values
927 * @return HTMLForm $this for chaining calls
929 public function addHiddenFields( array $fields ) {
930 foreach ( $fields as $name => $value ) {
931 $this->mHiddenFields
[] = [ $value, [ 'name' => $name ] ];
938 * Add a button to the form
940 * @since 1.27 takes an array as shown. Earlier versions accepted
941 * 'name', 'value', 'id', and 'attribs' as separate parameters in that
943 * @note Custom labels ('label', 'label-message', 'label-raw') are not
944 * supported for IE6 and IE7 due to bugs in those browsers. If detected,
945 * they will be served buttons using 'value' as the button label.
946 * @param array $data Data to define the button:
947 * - name: (string) Button name.
948 * - value: (string) Button value.
949 * - label-message: (string, optional) Button label message key to use
950 * instead of 'value'. Overrides 'label' and 'label-raw'.
951 * - label: (string, optional) Button label text to use instead of
952 * 'value'. Overrides 'label-raw'.
953 * - label-raw: (string, optional) Button label HTML to use instead of
955 * - id: (string, optional) DOM id for the button.
956 * - attribs: (array, optional) Additional HTML attributes.
957 * - flags: (string|string[], optional) OOUI flags.
958 * - framed: (boolean=true, optional) OOUI framed attribute.
959 * @return HTMLForm $this for chaining calls (since 1.20)
961 public function addButton( $data ) {
962 if ( !is_array( $data ) ) {
963 $args = func_get_args();
964 if ( count( $args ) < 2 ||
count( $args ) > 4 ) {
965 throw new InvalidArgumentException(
966 'Incorrect number of arguments for deprecated calling style'
972 'id' => isset( $args[2] ) ?
$args[2] : null,
973 'attribs' => isset( $args[3] ) ?
$args[3] : null,
976 if ( !isset( $data['name'] ) ) {
977 throw new InvalidArgumentException( 'A name is required' );
979 if ( !isset( $data['value'] ) ) {
980 throw new InvalidArgumentException( 'A value is required' );
983 $this->mButtons
[] = $data +
[
994 * Set the salt for the edit token.
996 * Only useful when the method is "post".
999 * @param string|array $salt Salt to use
1000 * @return HTMLForm $this For chaining calls
1002 public function setTokenSalt( $salt ) {
1003 $this->mTokenSalt
= $salt;
1009 * Display the form (sending to the context's OutputPage object), with an
1010 * appropriate error message or stack of messages, and any validation errors, etc.
1012 * @attention You should call prepareForm() before calling this function.
1013 * Moreover, when doing method chaining this should be the very last method
1014 * call just after prepareForm().
1016 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
1018 * @return void Nothing, should be last call
1020 public function displayForm( $submitResult ) {
1021 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1025 * Returns the raw HTML generated by the form
1027 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
1029 * @return string HTML
1031 public function getHTML( $submitResult ) {
1032 # For good measure (it is the default)
1033 $this->getOutput()->preventClickjacking();
1034 $this->getOutput()->addModules( 'mediawiki.htmlform' );
1035 $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1038 . $this->getErrorsOrWarnings( $submitResult, 'error' )
1039 . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1040 . $this->getHeaderText()
1042 . $this->getHiddenFields()
1043 . $this->getButtons()
1044 . $this->getFooterText();
1046 $html = $this->wrapForm( $html );
1048 return '' . $this->mPre
. $html . $this->mPost
;
1052 * Get HTML attributes for the `<form>` tag.
1055 protected function getFormAttributes() {
1056 # Use multipart/form-data
1057 $encType = $this->mUseMultipart
1058 ?
'multipart/form-data'
1059 : 'application/x-www-form-urlencoded';
1062 'class' => 'mw-htmlform',
1063 'action' => $this->getAction(),
1064 'method' => $this->getMethod(),
1065 'enctype' => $encType,
1068 $attribs['id'] = $this->mId
;
1070 if ( is_string( $this->mAutocomplete
) ) {
1071 $attribs['autocomplete'] = $this->mAutocomplete
;
1073 if ( $this->mName
) {
1074 $attribs['name'] = $this->mName
;
1076 if ( $this->needsJSForHtml5FormValidation() ) {
1077 $attribs['novalidate'] = true;
1083 * Wrap the form innards in an actual "<form>" element
1085 * @param string $html HTML contents to wrap.
1087 * @return string Wrapped HTML.
1089 public function wrapForm( $html ) {
1090 # Include a <fieldset> wrapper for style, if requested.
1091 if ( $this->mWrapperLegend
!== false ) {
1092 $legend = is_string( $this->mWrapperLegend
) ?
$this->mWrapperLegend
: false;
1093 $html = Xml
::fieldset( $legend, $html );
1096 return Html
::rawElement(
1098 $this->getFormAttributes(),
1104 * Get the hidden fields that should go inside the form.
1105 * @return string HTML.
1107 public function getHiddenFields() {
1109 if ( $this->mFormIdentifier
!== null ) {
1110 $html .= Html
::hidden(
1112 $this->mFormIdentifier
1115 if ( $this->getMethod() === 'post' ) {
1116 $html .= Html
::hidden(
1118 $this->getUser()->getEditToken( $this->mTokenSalt
),
1119 [ 'id' => 'wpEditToken' ]
1121 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1124 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1125 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1126 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1129 foreach ( $this->mHiddenFields
as $data ) {
1130 list( $value, $attribs ) = $data;
1131 $html .= Html
::hidden( $attribs['name'], $value, $attribs ) . "\n";
1138 * Get the submit and (potentially) reset buttons.
1139 * @return string HTML.
1141 public function getButtons() {
1143 $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1145 if ( $this->mShowSubmit
) {
1148 if ( isset( $this->mSubmitID
) ) {
1149 $attribs['id'] = $this->mSubmitID
;
1152 if ( isset( $this->mSubmitName
) ) {
1153 $attribs['name'] = $this->mSubmitName
;
1156 if ( isset( $this->mSubmitTooltip
) ) {
1157 $attribs +
= Linker
::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip
);
1160 $attribs['class'] = [ 'mw-htmlform-submit' ];
1162 if ( $useMediaWikiUIEverywhere ) {
1163 foreach ( $this->mSubmitFlags
as $flag ) {
1164 $attribs['class'][] = 'mw-ui-' . $flag;
1166 $attribs['class'][] = 'mw-ui-button';
1169 $buttons .= Xml
::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1172 if ( $this->mShowReset
) {
1173 $buttons .= Html
::element(
1177 'value' => $this->msg( 'htmlform-reset' )->text(),
1178 'class' => $useMediaWikiUIEverywhere ?
'mw-ui-button' : null,
1183 if ( $this->mShowCancel
) {
1184 $target = $this->mCancelTarget ?
: Title
::newMainPage();
1185 if ( $target instanceof Title
) {
1186 $target = $target->getLocalURL();
1188 $buttons .= Html
::element(
1191 'class' => $useMediaWikiUIEverywhere ?
'mw-ui-button' : null,
1194 $this->msg( 'cancel' )->text()
1198 // IE<8 has bugs with <button>, so we'll need to avoid them.
1199 $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1201 foreach ( $this->mButtons
as $button ) {
1204 'name' => $button['name'],
1205 'value' => $button['value']
1208 if ( isset( $button['label-message'] ) ) {
1209 $label = $this->getMessage( $button['label-message'] )->parse();
1210 } elseif ( isset( $button['label'] ) ) {
1211 $label = htmlspecialchars( $button['label'] );
1212 } elseif ( isset( $button['label-raw'] ) ) {
1213 $label = $button['label-raw'];
1215 $label = htmlspecialchars( $button['value'] );
1218 if ( $button['attribs'] ) {
1219 $attrs +
= $button['attribs'];
1222 if ( isset( $button['id'] ) ) {
1223 $attrs['id'] = $button['id'];
1226 if ( $useMediaWikiUIEverywhere ) {
1227 $attrs['class'] = isset( $attrs['class'] ) ?
(array)$attrs['class'] : [];
1228 $attrs['class'][] = 'mw-ui-button';
1232 $buttons .= Html
::element( 'input', $attrs ) . "\n";
1234 $buttons .= Html
::rawElement( 'button', $attrs, $label ) . "\n";
1242 return Html
::rawElement( 'span',
1243 [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1247 * Get the whole body of the form.
1250 public function getBody() {
1251 return $this->displaySection( $this->mFieldTree
, $this->mTableId
);
1255 * Format and display an error message stack.
1257 * @param string|array|Status $errors
1259 * @deprecated since 1.28, use getErrorsOrWarnings() instead
1263 public function getErrors( $errors ) {
1264 wfDeprecated( __METHOD__
);
1265 return $this->getErrorsOrWarnings( $errors, 'error' );
1269 * Returns a formatted list of errors or warnings from the given elements.
1271 * @param string|array|Status $elements The set of errors/warnings to process.
1272 * @param string $elementsType Should warnings or errors be returned. This is meant
1273 * for Status objects, all other valid types are always considered as errors.
1276 public function getErrorsOrWarnings( $elements, $elementsType ) {
1277 if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1278 throw new DomainException( $elementsType . ' is not a valid type.' );
1280 $elementstr = false;
1281 if ( $elements instanceof Status
) {
1282 list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1283 $status = $elementsType === 'error' ?
$errorStatus : $warningStatus;
1284 if ( $status->isGood() ) {
1287 $elementstr = $this->getOutput()->parse(
1288 $status->getWikiText()
1291 } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1292 $elementstr = $this->formatErrors( $elements );
1293 } elseif ( $elementsType === 'error' ) {
1294 $elementstr = $elements;
1298 ? Html
::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1303 * Format a stack of error messages into a single HTML string
1305 * @param array $errors Array of message keys/values
1307 * @return string HTML, a "<ul>" list of errors
1309 public function formatErrors( $errors ) {
1312 foreach ( $errors as $error ) {
1313 $errorstr .= Html
::rawElement(
1316 $this->getMessage( $error )->parse()
1320 $errorstr = Html
::rawElement( 'ul', [], $errorstr );
1326 * Set the text for the submit button
1328 * @param string $t Plaintext
1330 * @return HTMLForm $this for chaining calls (since 1.20)
1332 public function setSubmitText( $t ) {
1333 $this->mSubmitText
= $t;
1339 * Identify that the submit button in the form has a destructive action
1342 * @return HTMLForm $this for chaining calls (since 1.28)
1344 public function setSubmitDestructive() {
1345 $this->mSubmitFlags
= [ 'destructive', 'primary' ];
1351 * Identify that the submit button in the form has a progressive action
1354 * @return HTMLForm $this for chaining calls (since 1.28)
1356 public function setSubmitProgressive() {
1357 $this->mSubmitFlags
= [ 'progressive', 'primary' ];
1363 * Set the text for the submit button to a message
1366 * @param string|Message $msg Message key or Message object
1368 * @return HTMLForm $this for chaining calls (since 1.20)
1370 public function setSubmitTextMsg( $msg ) {
1371 if ( !$msg instanceof Message
) {
1372 $msg = $this->msg( $msg );
1374 $this->setSubmitText( $msg->text() );
1380 * Get the text for the submit button, either customised or a default.
1383 public function getSubmitText() {
1384 return $this->mSubmitText ?
: $this->msg( 'htmlform-submit' )->text();
1388 * @param string $name Submit button name
1390 * @return HTMLForm $this for chaining calls (since 1.20)
1392 public function setSubmitName( $name ) {
1393 $this->mSubmitName
= $name;
1399 * @param string $name Tooltip for the submit button
1401 * @return HTMLForm $this for chaining calls (since 1.20)
1403 public function setSubmitTooltip( $name ) {
1404 $this->mSubmitTooltip
= $name;
1410 * Set the id for the submit button.
1414 * @todo FIXME: Integrity of $t is *not* validated
1415 * @return HTMLForm $this for chaining calls (since 1.20)
1417 public function setSubmitID( $t ) {
1418 $this->mSubmitID
= $t;
1424 * Set an internal identifier for this form. It will be submitted as a hidden form field, allowing
1425 * HTMLForm to determine whether the form was submitted (or merely viewed). Setting this serves
1428 * - If you use two or more forms on one page, it allows HTMLForm to identify which of the forms
1429 * was submitted, and not attempt to validate the other ones.
1430 * - If you use checkbox or multiselect fields inside a form using the GET method, it allows
1431 * HTMLForm to distinguish between the initial page view and a form submission with all
1432 * checkboxes or select options unchecked.
1435 * @param string $ident
1438 public function setFormIdentifier( $ident ) {
1439 $this->mFormIdentifier
= $ident;
1445 * Stop a default submit button being shown for this form. This implies that an
1446 * alternate submit method must be provided manually.
1450 * @param bool $suppressSubmit Set to false to re-enable the button again
1452 * @return HTMLForm $this for chaining calls
1454 public function suppressDefaultSubmit( $suppressSubmit = true ) {
1455 $this->mShowSubmit
= !$suppressSubmit;
1461 * Show a cancel button (or prevent it). The button is not shown by default.
1463 * @return HTMLForm $this for chaining calls
1466 public function showCancel( $show = true ) {
1467 $this->mShowCancel
= $show;
1472 * Sets the target where the user is redirected to after clicking cancel.
1473 * @param Title|string $target Target as a Title object or an URL
1474 * @return HTMLForm $this for chaining calls
1477 public function setCancelTarget( $target ) {
1478 $this->mCancelTarget
= $target;
1483 * Set the id of the \<table\> or outermost \<div\> element.
1487 * @param string $id New value of the id attribute, or "" to remove
1489 * @return HTMLForm $this for chaining calls
1491 public function setTableId( $id ) {
1492 $this->mTableId
= $id;
1498 * @param string $id DOM id for the form
1500 * @return HTMLForm $this for chaining calls (since 1.20)
1502 public function setId( $id ) {
1509 * @param string $name 'name' attribute for the form
1510 * @return HTMLForm $this for chaining calls
1512 public function setName( $name ) {
1513 $this->mName
= $name;
1519 * Prompt the whole form to be wrapped in a "<fieldset>", with
1520 * this text as its "<legend>" element.
1522 * @param string|bool $legend If false, no wrapper or legend will be displayed.
1523 * If true, a wrapper will be displayed, but no legend.
1524 * If a string, a wrapper will be displayed with that string as a legend.
1525 * The string will be escaped before being output (this doesn't support HTML).
1527 * @return HTMLForm $this for chaining calls (since 1.20)
1529 public function setWrapperLegend( $legend ) {
1530 $this->mWrapperLegend
= $legend;
1536 * Prompt the whole form to be wrapped in a "<fieldset>", with
1537 * this message as its "<legend>" element.
1540 * @param string|Message $msg Message key or Message object
1542 * @return HTMLForm $this for chaining calls (since 1.20)
1544 public function setWrapperLegendMsg( $msg ) {
1545 if ( !$msg instanceof Message
) {
1546 $msg = $this->msg( $msg );
1548 $this->setWrapperLegend( $msg->text() );
1554 * Set the prefix for various default messages
1555 * @todo Currently only used for the "<fieldset>" legend on forms
1556 * with multiple sections; should be used elsewhere?
1560 * @return HTMLForm $this for chaining calls (since 1.20)
1562 public function setMessagePrefix( $p ) {
1563 $this->mMessagePrefix
= $p;
1569 * Set the title for form submission
1571 * @param Title $t Title of page the form is on/should be posted to
1573 * @return HTMLForm $this for chaining calls (since 1.20)
1575 public function setTitle( $t ) {
1585 public function getTitle() {
1586 return $this->mTitle
=== false
1587 ?
$this->getContext()->getTitle()
1592 * Set the method used to submit the form
1594 * @param string $method
1596 * @return HTMLForm $this for chaining calls (since 1.20)
1598 public function setMethod( $method = 'post' ) {
1599 $this->mMethod
= strtolower( $method );
1605 * @return string Always lowercase
1607 public function getMethod() {
1608 return $this->mMethod
;
1612 * Wraps the given $section into an user-visible fieldset.
1614 * @param string $legend Legend text for the fieldset
1615 * @param string $section The section content in plain Html
1616 * @param array $attributes Additional attributes for the fieldset
1617 * @return string The fieldset's Html
1619 protected function wrapFieldSetSection( $legend, $section, $attributes ) {
1620 return Xml
::fieldset( $legend, $section, $attributes ) . "\n";
1626 * @param array[]|HTMLFormField[] $fields Array of fields (either arrays or
1628 * @param string $sectionName ID attribute of the "<table>" tag for this
1629 * section, ignored if empty.
1630 * @param string $fieldsetIDPrefix ID prefix for the "<fieldset>" tag of
1631 * each subsection, ignored if empty.
1632 * @param bool &$hasUserVisibleFields Whether the section had user-visible fields.
1633 * @throws LogicException When called on uninitialized field data, e.g. When
1634 * HTMLForm::displayForm was called without calling HTMLForm::prepareForm
1639 public function displaySection( $fields,
1641 $fieldsetIDPrefix = '',
1642 &$hasUserVisibleFields = false
1644 if ( $this->mFieldData
=== null ) {
1645 throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1646 . 'You probably called displayForm() without calling prepareForm() first.' );
1649 $displayFormat = $this->getDisplayFormat();
1652 $subsectionHtml = '';
1655 // Conveniently, PHP method names are case-insensitive.
1656 // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1657 $getFieldHtmlMethod = $displayFormat === 'table' ?
'getTableRow' : ( 'get' . $displayFormat );
1659 foreach ( $fields as $key => $value ) {
1660 if ( $value instanceof HTMLFormField
) {
1661 $v = array_key_exists( $key, $this->mFieldData
)
1662 ?
$this->mFieldData
[$key]
1663 : $value->getDefault();
1665 $retval = $value->$getFieldHtmlMethod( $v );
1667 // check, if the form field should be added to
1669 if ( $value->hasVisibleOutput() ) {
1672 $labelValue = trim( $value->getLabel() );
1673 if ( $labelValue !== ' ' && $labelValue !== '' ) {
1677 $hasUserVisibleFields = true;
1679 } elseif ( is_array( $value ) ) {
1680 $subsectionHasVisibleFields = false;
1682 $this->displaySection( $value,
1684 "$fieldsetIDPrefix$key-",
1685 $subsectionHasVisibleFields );
1688 if ( $subsectionHasVisibleFields === true ) {
1689 // Display the section with various niceties.
1690 $hasUserVisibleFields = true;
1692 $legend = $this->getLegend( $key );
1694 $section = $this->getHeaderText( $key ) .
1696 $this->getFooterText( $key );
1699 if ( $fieldsetIDPrefix ) {
1700 $attributes['id'] = Sanitizer
::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1702 $subsectionHtml .= $this->wrapFieldSetSection( $legend, $section, $attributes );
1704 // Just return the inputs, nothing fancy.
1705 $subsectionHtml .= $section;
1710 $html = $this->formatSection( $html, $sectionName, $hasLabel );
1712 if ( $subsectionHtml ) {
1713 if ( $this->mSubSectionBeforeFields
) {
1714 return $subsectionHtml . "\n" . $html;
1716 return $html . "\n" . $subsectionHtml;
1724 * Put a form section together from the individual fields' HTML, merging it and wrapping.
1725 * @param array $fieldsHtml
1726 * @param string $sectionName
1727 * @param bool $anyFieldHasLabel
1728 * @return string HTML
1730 protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1731 if ( !$fieldsHtml ) {
1732 // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1733 // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1737 $displayFormat = $this->getDisplayFormat();
1738 $html = implode( '', $fieldsHtml );
1740 if ( $displayFormat === 'raw' ) {
1746 if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1747 $classes[] = 'mw-htmlform-nolabel';
1751 'class' => implode( ' ', $classes ),
1754 if ( $sectionName ) {
1755 $attribs['id'] = Sanitizer
::escapeIdForAttribute( $sectionName );
1758 if ( $displayFormat === 'table' ) {
1759 return Html
::rawElement( 'table',
1761 Html
::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1762 } elseif ( $displayFormat === 'inline' ) {
1763 return Html
::rawElement( 'span', $attribs, "\n$html\n" );
1765 return Html
::rawElement( 'div', $attribs, "\n$html\n" );
1770 * Construct the form fields from the Descriptor array
1772 public function loadData() {
1775 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1776 $request = $this->getRequest();
1777 if ( $field->skipLoadData( $request ) ) {
1779 } elseif ( !empty( $field->mParams
['disabled'] ) ) {
1780 $fieldData[$fieldname] = $field->getDefault();
1782 $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1787 foreach ( $fieldData as $name => &$value ) {
1788 $field = $this->mFlatFields
[$name];
1789 $value = $field->filter( $value, $this->mFlatFields
);
1792 $this->mFieldData
= $fieldData;
1796 * Stop a reset button being shown for this form
1798 * @param bool $suppressReset Set to false to re-enable the button again
1800 * @return HTMLForm $this for chaining calls (since 1.20)
1802 public function suppressReset( $suppressReset = true ) {
1803 $this->mShowReset
= !$suppressReset;
1809 * Overload this if you want to apply special filtration routines
1810 * to the form as a whole, after it's submitted but before it's
1813 * @param array $data
1817 public function filterDataForSubmit( $data ) {
1822 * Get a string to go in the "<legend>" of a section fieldset.
1823 * Override this if you want something more complicated.
1825 * @param string $key
1829 public function getLegend( $key ) {
1830 return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1834 * Set the value for the action attribute of the form.
1835 * When set to false (which is the default state), the set title is used.
1839 * @param string|bool $action
1841 * @return HTMLForm $this for chaining calls (since 1.20)
1843 public function setAction( $action ) {
1844 $this->mAction
= $action;
1850 * Get the value for the action attribute of the form.
1856 public function getAction() {
1857 // If an action is alredy provided, return it
1858 if ( $this->mAction
!== false ) {
1859 return $this->mAction
;
1862 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1863 // Check whether we are in GET mode and the ArticlePath contains a "?"
1864 // meaning that getLocalURL() would return something like "index.php?title=...".
1865 // As browser remove the query string before submitting GET forms,
1866 // it means that the title would be lost. In such case use wfScript() instead
1867 // and put title in an hidden field (see getHiddenFields()).
1868 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1872 return $this->getTitle()->getLocalURL();
1876 * Set the value for the autocomplete attribute of the form. A typical value is "off".
1877 * When set to null (which is the default state), the attribute get not set.
1881 * @param string|null $autocomplete
1883 * @return HTMLForm $this for chaining calls
1885 public function setAutocomplete( $autocomplete ) {
1886 $this->mAutocomplete
= $autocomplete;
1892 * Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a
1893 * name + parameters array) into a Message.
1894 * @param mixed $value
1897 protected function getMessage( $value ) {
1898 return Message
::newFromSpecifier( $value )->setContext( $this );
1902 * Whether this form, with its current fields, requires the user agent to have JavaScript enabled
1903 * for the client-side HTML5 form validation to work correctly. If this function returns true, a
1904 * 'novalidate' attribute will be added on the `<form>` element. It will be removed if the user
1905 * agent has JavaScript support, in htmlform.js.
1910 public function needsJSForHtml5FormValidation() {
1911 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1912 if ( $field->needsJSForHtml5FormValidation() ) {