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 raw text labels to values.
61 * Some field types support multi-level arrays.
62 * Overwrites 'options-message'.
63 * 'options-messages' -- associative array mapping message keys to values.
64 * Some field types support multi-level arrays.
65 * Overwrites 'options' and 'options-message'.
66 * 'options-message' -- message key or object to be parsed to extract the list of
67 * options (like 'ipbreason-dropdown').
68 * 'label-message' -- message key or object for a message to use as the label.
69 * can be an array of msg key and then parameters to
71 * 'label' -- alternatively, a raw text message. Overridden by
73 * 'help' -- message text for a message to use as a help text.
74 * 'help-message' -- message key or object for a message to use as a help text.
75 * can be an array of msg key and then parameters to
77 * Overwrites 'help-messages' and 'help'.
78 * 'help-messages' -- array of message keys/objects. As above, each item can
79 * be an array of msg key and then parameters.
81 * 'help-inline' -- Whether help text (defined using options above) will be shown
82 * inline after the input field, rather than in a popup.
83 * Defaults to true. Only used by OOUI form fields.
84 * 'notice' -- (deprecated, use 'help' instead)
85 * 'notice-messages' -- (deprecated, use 'help-messages' instead)
86 * 'notice-message' -- (deprecated, use 'help-message' instead)
87 * 'required' -- passed through to the object, indicating that it
88 * is a required field.
89 * 'size' -- the length of text fields
90 * 'filter-callback' -- a function name to give you the chance to
91 * massage the inputted value before it's processed.
92 * @see HTMLFormField::filter()
93 * 'validation-callback' -- a function name to give you the chance
94 * to impose extra validation on the field input.
95 * @see HTMLFormField::validate()
96 * 'name' -- By default, the 'name' attribute of the input field
97 * is "wp{$fieldname}". If you want a different name
98 * (eg one without the "wp" prefix), specify it here and
99 * it will be used without modification.
100 * 'hide-if' -- expression given as an array stating when the field
101 * should be hidden. The first array value has to be the
102 * expression's logic operator. Supported expressions:
104 * [ 'NOT', array $expression ]
105 * To hide a field if a given expression is not true.
107 * [ '===', string $fieldName, string $value ]
108 * To hide a field if another field identified by
109 * $field has the value $value.
111 * [ '!==', string $fieldName, string $value ]
112 * Same as [ 'NOT', [ '===', $fieldName, $value ]
113 * 'OR', 'AND', 'NOR', 'NAND'
114 * [ 'XXX', array $expression1, ..., array $expressionN ]
115 * To hide a field if one or more (OR), all (AND),
116 * neither (NOR) or not all (NAND) given expressions
117 * are evaluated as true.
118 * The expressions will be given to a JavaScript frontend
119 * module which will continually update the field's
122 * Since 1.20, you can chain mutators to ease the form generation:
125 * $form = new HTMLForm( $someFields );
126 * $form->setMethod( 'get' )
127 * ->setWrapperLegendMsg( 'message-key' )
129 * ->displayForm( '' );
131 * Note that you will have prepareForm and displayForm at the end. Other
132 * methods call done after that would simply not be part of the form :(
134 * @todo Document 'section' / 'subsection' stuff
136 class HTMLForm
extends ContextSource
{
137 // A mapping of 'type' inputs onto standard HTMLFormField subclasses
138 public static $typeMappings = [
139 'api' => HTMLApiField
::class,
140 'text' => HTMLTextField
::class,
141 'textwithbutton' => HTMLTextFieldWithButton
::class,
142 'textarea' => HTMLTextAreaField
::class,
143 'select' => HTMLSelectField
::class,
144 'combobox' => HTMLComboboxField
::class,
145 'radio' => HTMLRadioField
::class,
146 'multiselect' => HTMLMultiSelectField
::class,
147 'limitselect' => HTMLSelectLimitField
::class,
148 'check' => HTMLCheckField
::class,
149 'toggle' => HTMLCheckField
::class,
150 'int' => HTMLIntField
::class,
151 'float' => HTMLFloatField
::class,
152 'info' => HTMLInfoField
::class,
153 'selectorother' => HTMLSelectOrOtherField
::class,
154 'selectandother' => HTMLSelectAndOtherField
::class,
155 'namespaceselect' => HTMLSelectNamespace
::class,
156 'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton
::class,
157 'tagfilter' => HTMLTagFilter
::class,
158 'sizefilter' => HTMLSizeFilterField
::class,
159 'submit' => HTMLSubmitField
::class,
160 'hidden' => HTMLHiddenField
::class,
161 'edittools' => HTMLEditTools
::class,
162 'checkmatrix' => HTMLCheckMatrix
::class,
163 'cloner' => HTMLFormFieldCloner
::class,
164 'autocompleteselect' => HTMLAutoCompleteSelectField
::class,
165 'date' => HTMLDateTimeField
::class,
166 'time' => HTMLDateTimeField
::class,
167 'datetime' => HTMLDateTimeField
::class,
168 'expiry' => HTMLExpiryField
::class,
169 // HTMLTextField will output the correct type="" attribute automagically.
170 // There are about four zillion other HTML5 input types, like range, but
171 // we don't use those at the moment, so no point in adding all of them.
172 'email' => HTMLTextField
::class,
173 'password' => HTMLTextField
::class,
174 'url' => HTMLTextField
::class,
175 'title' => HTMLTitleTextField
::class,
176 'user' => HTMLUserTextField
::class,
177 'usersmultiselect' => HTMLUsersMultiselectField
::class,
182 protected $mMessagePrefix;
184 /** @var HTMLFormField[] */
185 protected $mFlatFields;
187 protected $mFieldTree;
188 protected $mShowReset = false;
189 protected $mShowSubmit = true;
190 protected $mSubmitFlags = [ 'primary', 'progressive' ];
191 protected $mShowCancel = false;
192 protected $mCancelTarget;
194 protected $mSubmitCallback;
195 protected $mValidationErrorMessage;
197 protected $mPre = '';
198 protected $mHeader = '';
199 protected $mFooter = '';
200 protected $mSectionHeaders = [];
201 protected $mSectionFooters = [];
202 protected $mPost = '';
205 protected $mTableId = '';
207 protected $mSubmitID;
208 protected $mSubmitName;
209 protected $mSubmitText;
210 protected $mSubmitTooltip;
212 protected $mFormIdentifier;
214 protected $mMethod = 'post';
215 protected $mWasSubmitted = false;
218 * Form action URL. false means we will use the URL to set Title
222 protected $mAction = false;
225 * Form attribute autocomplete. A typical value is "off". null does not set the attribute
229 protected $mAutocomplete = null;
231 protected $mUseMultipart = false;
232 protected $mHiddenFields = [];
233 protected $mButtons = [];
235 protected $mWrapperLegend = false;
238 * Salt for the edit token.
241 protected $mTokenSalt = '';
244 * If true, sections that contain both fields and subsections will
245 * render their subsections before their fields.
247 * Subclasses may set this to false to render subsections after fields
250 protected $mSubSectionBeforeFields = true;
253 * Format in which to display form. For viable options,
254 * @see $availableDisplayFormats
257 protected $displayFormat = 'table';
260 * Available formats in which to display the form
263 protected $availableDisplayFormats = [
271 * Available formats in which to display the form
274 protected $availableSubclassDisplayFormats = [
280 * Construct a HTMLForm object for given display type. May return a HTMLForm subclass.
282 * @param string $displayFormat
283 * @param mixed $arguments,... Additional arguments to pass to the constructor.
286 public static function factory( $displayFormat/*, $arguments...*/ ) {
287 $arguments = func_get_args();
288 array_shift( $arguments );
290 switch ( $displayFormat ) {
292 return ObjectFactory
::constructClassInstance( VFormHTMLForm
::class, $arguments );
294 return ObjectFactory
::constructClassInstance( OOUIHTMLForm
::class, $arguments );
296 /** @var HTMLForm $form */
297 $form = ObjectFactory
::constructClassInstance( self
::class, $arguments );
298 $form->setDisplayFormat( $displayFormat );
304 * Build a new HTMLForm from an array of field attributes
306 * @param array $descriptor Array of Field constructs, as described above
307 * @param IContextSource|null $context Available since 1.18, will become compulsory in 1.18.
308 * Obviates the need to call $form->setTitle()
309 * @param string $messagePrefix A prefix to go in front of default messages
311 public function __construct( $descriptor, /*IContextSource*/ $context = null,
314 if ( $context instanceof IContextSource
) {
315 $this->setContext( $context );
316 $this->mTitle
= false; // We don't need them to set a title
317 $this->mMessagePrefix
= $messagePrefix;
318 } elseif ( $context === null && $messagePrefix !== '' ) {
319 $this->mMessagePrefix
= $messagePrefix;
320 } elseif ( is_string( $context ) && $messagePrefix === '' ) {
322 // it's actually $messagePrefix
323 $this->mMessagePrefix
= $context;
326 // Evil hack for mobile :(
328 !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
329 && $this->displayFormat
=== 'table'
331 $this->displayFormat
= 'div';
334 // Expand out into a tree.
335 $loadedDescriptor = [];
336 $this->mFlatFields
= [];
338 foreach ( $descriptor as $fieldname => $info ) {
339 $section = $info['section'] ??
'';
341 if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
342 $this->mUseMultipart
= true;
345 $field = static::loadInputFromParameters( $fieldname, $info, $this );
347 $setSection =& $loadedDescriptor;
349 $sectionParts = explode( '/', $section );
351 while ( count( $sectionParts ) ) {
352 $newName = array_shift( $sectionParts );
354 if ( !isset( $setSection[$newName] ) ) {
355 $setSection[$newName] = [];
358 $setSection =& $setSection[$newName];
362 $setSection[$fieldname] = $field;
363 $this->mFlatFields
[$fieldname] = $field;
366 $this->mFieldTree
= $loadedDescriptor;
370 * @param string $fieldname
373 public function hasField( $fieldname ) {
374 return isset( $this->mFlatFields
[$fieldname] );
378 * @param string $fieldname
379 * @return HTMLFormField
380 * @throws DomainException on invalid field name
382 public function getField( $fieldname ) {
383 if ( !$this->hasField( $fieldname ) ) {
384 throw new DomainException( __METHOD__
. ': no field named ' . $fieldname );
386 return $this->mFlatFields
[$fieldname];
390 * Set format in which to display the form
392 * @param string $format The name of the format to use, must be one of
393 * $this->availableDisplayFormats
395 * @throws MWException
397 * @return HTMLForm $this for chaining calls (since 1.20)
399 public function setDisplayFormat( $format ) {
401 in_array( $format, $this->availableSubclassDisplayFormats
, true ) ||
402 in_array( $this->displayFormat
, $this->availableSubclassDisplayFormats
, true )
404 throw new MWException( 'Cannot change display format after creation, ' .
405 'use HTMLForm::factory() instead' );
408 if ( !in_array( $format, $this->availableDisplayFormats
, true ) ) {
409 throw new MWException( 'Display format must be one of ' .
412 $this->availableDisplayFormats
,
413 $this->availableSubclassDisplayFormats
419 // Evil hack for mobile :(
420 if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
424 $this->displayFormat
= $format;
430 * Getter for displayFormat
434 public function getDisplayFormat() {
435 return $this->displayFormat
;
439 * Get the HTMLFormField subclass for this descriptor.
441 * The descriptor can be passed either 'class' which is the name of
442 * a HTMLFormField subclass, or a shorter 'type' which is an alias.
443 * This makes sure the 'class' is always set, and also is returned by
444 * this function for ease.
448 * @param string $fieldname Name of the field
449 * @param array &$descriptor Input Descriptor, as described above
451 * @throws MWException
452 * @return string Name of a HTMLFormField subclass
454 public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
455 if ( isset( $descriptor['class'] ) ) {
456 $class = $descriptor['class'];
457 } elseif ( isset( $descriptor['type'] ) ) {
458 $class = static::$typeMappings[$descriptor['type']];
459 $descriptor['class'] = $class;
465 throw new MWException( "Descriptor with no class for $fieldname: "
466 . print_r( $descriptor, true ) );
473 * Initialise a new Object for the field
475 * @param string $fieldname Name of the field
476 * @param array $descriptor Input Descriptor, as described above
477 * @param HTMLForm|null $parent Parent instance of HTMLForm
479 * @throws MWException
480 * @return HTMLFormField Instance of a subclass of HTMLFormField
482 public static function loadInputFromParameters( $fieldname, $descriptor,
483 HTMLForm
$parent = null
485 $class = static::getClassFromDescriptor( $fieldname, $descriptor );
487 $descriptor['fieldname'] = $fieldname;
489 $descriptor['parent'] = $parent;
492 # @todo This will throw a fatal error whenever someone try to use
493 # 'class' to feed a CSS class instead of 'cssclass'. Would be
494 # great to avoid the fatal error and show a nice error.
495 return new $class( $descriptor );
499 * Prepare form for submission.
501 * @warning When doing method chaining, that should be the very last
502 * method call before displayForm().
504 * @throws MWException
505 * @return HTMLForm $this for chaining calls (since 1.20)
507 public function prepareForm() {
508 # Check if we have the info we need
509 if ( !$this->mTitle
instanceof Title
&& $this->mTitle
!== false ) {
510 throw new MWException( 'You must call setTitle() on an HTMLForm' );
513 # Load data from the request.
515 $this->mFormIdentifier
=== null ||
516 $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
520 $this->mFieldData
= [];
527 * Try submitting, with edit token check first
528 * @return Status|bool
530 public function tryAuthorizedSubmit() {
534 if ( $this->mFormIdentifier
=== null ) {
537 $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
;
541 if ( $this->getMethod() !== 'post' ) {
542 $tokenOkay = true; // no session check needed
543 } elseif ( $this->getRequest()->wasPosted() ) {
544 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
545 if ( $this->getUser()->isLoggedIn() ||
$editToken !== null ) {
546 // Session tokens for logged-out users have no security value.
547 // However, if the user gave one, check it in order to give a nice
548 // "session expired" error instead of "permission denied" or such.
549 $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt
);
555 if ( $tokenOkay && $identOkay ) {
556 $this->mWasSubmitted
= true;
557 $result = $this->trySubmit();
564 * The here's-one-I-made-earlier option: do the submission if
565 * posted, or display the form with or without funky validation
567 * @return bool|Status Whether submission was successful.
569 public function show() {
570 $this->prepareForm();
572 $result = $this->tryAuthorizedSubmit();
573 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ) {
577 $this->displayForm( $result );
583 * Same as self::show with the difference, that the form will be
584 * added to the output, no matter, if the validation was good or not.
585 * @return bool|Status Whether submission was successful.
587 public function showAlways() {
588 $this->prepareForm();
590 $result = $this->tryAuthorizedSubmit();
592 $this->displayForm( $result );
598 * Validate all the fields, and call the submission callback
599 * function if everything is kosher.
600 * @throws MWException
601 * @return bool|string|array|Status
602 * - Bool true or a good Status object indicates success,
603 * - Bool false indicates no submission was attempted,
604 * - Anything else indicates failure. The value may be a fatal Status
605 * object, an HTML string, or an array of arrays (message keys and
606 * params) or strings (message keys)
608 public function trySubmit() {
610 $hoistedErrors = Status
::newGood();
611 if ( $this->mValidationErrorMessage
) {
612 foreach ( (array)$this->mValidationErrorMessage
as $error ) {
613 $hoistedErrors->fatal( ...$error );
616 $hoistedErrors->fatal( 'htmlform-invalid-input' );
619 $this->mWasSubmitted
= true;
621 # Check for cancelled submission
622 foreach ( $this->mFlatFields
as $fieldname => $field ) {
623 if ( !array_key_exists( $fieldname, $this->mFieldData
) ) {
626 if ( $field->cancelSubmit( $this->mFieldData
[$fieldname], $this->mFieldData
) ) {
627 $this->mWasSubmitted
= false;
632 # Check for validation
633 foreach ( $this->mFlatFields
as $fieldname => $field ) {
634 if ( !array_key_exists( $fieldname, $this->mFieldData
) ) {
637 if ( $field->isHidden( $this->mFieldData
) ) {
640 $res = $field->validate( $this->mFieldData
[$fieldname], $this->mFieldData
);
641 if ( $res !== true ) {
643 if ( $res !== false && !$field->canDisplayErrors() ) {
644 if ( is_string( $res ) ) {
645 $hoistedErrors->fatal( 'rawmessage', $res );
647 $hoistedErrors->fatal( $res );
654 return $hoistedErrors;
657 $callback = $this->mSubmitCallback
;
658 if ( !is_callable( $callback ) ) {
659 throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
660 'setSubmitCallback() to set one.' );
663 $data = $this->filterDataForSubmit( $this->mFieldData
);
665 $res = call_user_func( $callback, $data, $this );
666 if ( $res === false ) {
667 $this->mWasSubmitted
= false;
674 * Test whether the form was considered to have been submitted or not, i.e.
675 * whether the last call to tryAuthorizedSubmit or trySubmit returned
678 * This will return false until HTMLForm::tryAuthorizedSubmit or
679 * HTMLForm::trySubmit is called.
684 public function wasSubmitted() {
685 return $this->mWasSubmitted
;
689 * Set a callback to a function to do something with the form
690 * once it's been successfully validated.
692 * @param callable $cb The function will be passed the output from
693 * HTMLForm::filterDataForSubmit and this HTMLForm object, and must
694 * return as documented for HTMLForm::trySubmit
696 * @return HTMLForm $this for chaining calls (since 1.20)
698 public function setSubmitCallback( $cb ) {
699 $this->mSubmitCallback
= $cb;
705 * Set a message to display on a validation error.
707 * @param string|array $msg String or Array of valid inputs to wfMessage()
708 * (so each entry can be either a String or Array)
710 * @return HTMLForm $this for chaining calls (since 1.20)
712 public function setValidationErrorMessage( $msg ) {
713 $this->mValidationErrorMessage
= $msg;
719 * Set the introductory message, overwriting any existing message.
721 * @param string $msg Complete text of message to display
723 * @return HTMLForm $this for chaining calls (since 1.20)
725 public function setIntro( $msg ) {
726 $this->setPreText( $msg );
732 * Set the introductory message HTML, overwriting any existing message.
735 * @param string $msg Complete HTML of message to display
737 * @return HTMLForm $this for chaining calls (since 1.20)
739 public function setPreText( $msg ) {
746 * Add HTML to introductory message.
748 * @param string $msg Complete HTML of message to display
750 * @return HTMLForm $this for chaining calls (since 1.20)
752 public function addPreText( $msg ) {
759 * Get the introductory message HTML.
765 public function getPreText() {
770 * Add HTML to the header, inside the form.
772 * @param string $msg Additional HTML to display in header
773 * @param string|null $section The section to add the header to
775 * @return HTMLForm $this for chaining calls (since 1.20)
777 public function addHeaderText( $msg, $section = null ) {
778 if ( $section === null ) {
779 $this->mHeader
.= $msg;
781 if ( !isset( $this->mSectionHeaders
[$section] ) ) {
782 $this->mSectionHeaders
[$section] = '';
784 $this->mSectionHeaders
[$section] .= $msg;
791 * Set header text, inside the form.
794 * @param string $msg Complete HTML of header to display
795 * @param string|null $section The section to add the header to
797 * @return HTMLForm $this for chaining calls (since 1.20)
799 public function setHeaderText( $msg, $section = null ) {
800 if ( $section === null ) {
801 $this->mHeader
= $msg;
803 $this->mSectionHeaders
[$section] = $msg;
812 * @param string|null $section The section to get the header text for
814 * @return string HTML
816 public function getHeaderText( $section = null ) {
817 if ( $section === null ) {
818 return $this->mHeader
;
820 return $this->mSectionHeaders
[$section] ??
'';
825 * Add footer text, inside the form.
827 * @param string $msg Complete text of message to display
828 * @param string|null $section The section to add the footer text to
830 * @return HTMLForm $this for chaining calls (since 1.20)
832 public function addFooterText( $msg, $section = null ) {
833 if ( $section === null ) {
834 $this->mFooter
.= $msg;
836 if ( !isset( $this->mSectionFooters
[$section] ) ) {
837 $this->mSectionFooters
[$section] = '';
839 $this->mSectionFooters
[$section] .= $msg;
846 * Set footer text, inside the form.
849 * @param string $msg Complete text of message to display
850 * @param string|null $section The section to add the footer text to
852 * @return HTMLForm $this for chaining calls (since 1.20)
854 public function setFooterText( $msg, $section = null ) {
855 if ( $section === null ) {
856 $this->mFooter
= $msg;
858 $this->mSectionFooters
[$section] = $msg;
867 * @param string|null $section The section to get the footer text for
871 public function getFooterText( $section = null ) {
872 if ( $section === null ) {
873 return $this->mFooter
;
875 return $this->mSectionFooters
[$section] ??
'';
880 * Add text to the end of the display.
882 * @param string $msg Complete text of message to display
884 * @return HTMLForm $this for chaining calls (since 1.20)
886 public function addPostText( $msg ) {
887 $this->mPost
.= $msg;
893 * Set text at the end of the display.
895 * @param string $msg Complete text of message to display
897 * @return HTMLForm $this for chaining calls (since 1.20)
899 public function setPostText( $msg ) {
906 * Add a hidden field to the output
908 * @param string $name Field name. This will be used exactly as entered
909 * @param string $value Field value
910 * @param array $attribs
912 * @return HTMLForm $this for chaining calls (since 1.20)
914 public function addHiddenField( $name, $value, array $attribs = [] ) {
915 $attribs +
= [ 'name' => $name ];
916 $this->mHiddenFields
[] = [ $value, $attribs ];
922 * Add an array of hidden fields to the output
926 * @param array $fields Associative array of fields to add;
927 * mapping names to their values
929 * @return HTMLForm $this for chaining calls
931 public function addHiddenFields( array $fields ) {
932 foreach ( $fields as $name => $value ) {
933 $this->mHiddenFields
[] = [ $value, [ 'name' => $name ] ];
940 * Add a button to the form
942 * @since 1.27 takes an array as shown. Earlier versions accepted
943 * 'name', 'value', 'id', and 'attribs' as separate parameters in that
945 * @note Custom labels ('label', 'label-message', 'label-raw') are not
946 * supported for IE6 and IE7 due to bugs in those browsers. If detected,
947 * they will be served buttons using 'value' as the button label.
948 * @param array $data Data to define the button:
949 * - name: (string) Button name.
950 * - value: (string) Button value.
951 * - label-message: (string, optional) Button label message key to use
952 * instead of 'value'. Overrides 'label' and 'label-raw'.
953 * - label: (string, optional) Button label text to use instead of
954 * 'value'. Overrides 'label-raw'.
955 * - label-raw: (string, optional) Button label HTML to use instead of
957 * - id: (string, optional) DOM id for the button.
958 * - attribs: (array, optional) Additional HTML attributes.
959 * - flags: (string|string[], optional) OOUI flags.
960 * - framed: (boolean=true, optional) OOUI framed attribute.
961 * @return HTMLForm $this for chaining calls (since 1.20)
963 public function addButton( $data ) {
964 if ( !is_array( $data ) ) {
965 $args = func_get_args();
966 if ( count( $args ) < 2 ||
count( $args ) > 4 ) {
967 throw new InvalidArgumentException(
968 'Incorrect number of arguments for deprecated calling style'
974 'id' => $args[2] ??
null,
975 'attribs' => $args[3] ??
null,
978 if ( !isset( $data['name'] ) ) {
979 throw new InvalidArgumentException( 'A name is required' );
981 if ( !isset( $data['value'] ) ) {
982 throw new InvalidArgumentException( 'A value is required' );
985 $this->mButtons
[] = $data +
[
996 * Set the salt for the edit token.
998 * Only useful when the method is "post".
1001 * @param string|array $salt Salt to use
1002 * @return HTMLForm $this For chaining calls
1004 public function setTokenSalt( $salt ) {
1005 $this->mTokenSalt
= $salt;
1011 * Display the form (sending to the context's OutputPage object), with an
1012 * appropriate error message or stack of messages, and any validation errors, etc.
1014 * @warning You should call prepareForm() before calling this function.
1015 * Moreover, when doing method chaining this should be the very last method
1016 * call just after prepareForm().
1018 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
1020 * @return void Nothing, should be last call
1022 public function displayForm( $submitResult ) {
1023 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1027 * Returns the raw HTML generated by the form
1029 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
1031 * @return string HTML
1032 * @return-taint escaped
1034 public function getHTML( $submitResult ) {
1035 # For good measure (it is the default)
1036 $this->getOutput()->preventClickjacking();
1037 $this->getOutput()->addModules( 'mediawiki.htmlform' );
1038 $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1041 . $this->getErrorsOrWarnings( $submitResult, 'error' )
1042 . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1043 . $this->getHeaderText()
1045 . $this->getHiddenFields()
1046 . $this->getButtons()
1047 . $this->getFooterText();
1049 $html = $this->wrapForm( $html );
1051 return '' . $this->mPre
. $html . $this->mPost
;
1055 * Get HTML attributes for the `<form>` tag.
1058 protected function getFormAttributes() {
1059 # Use multipart/form-data
1060 $encType = $this->mUseMultipart
1061 ?
'multipart/form-data'
1062 : 'application/x-www-form-urlencoded';
1065 'class' => 'mw-htmlform',
1066 'action' => $this->getAction(),
1067 'method' => $this->getMethod(),
1068 'enctype' => $encType,
1071 $attribs['id'] = $this->mId
;
1073 if ( is_string( $this->mAutocomplete
) ) {
1074 $attribs['autocomplete'] = $this->mAutocomplete
;
1076 if ( $this->mName
) {
1077 $attribs['name'] = $this->mName
;
1079 if ( $this->needsJSForHtml5FormValidation() ) {
1080 $attribs['novalidate'] = true;
1086 * Wrap the form innards in an actual "<form>" element
1088 * @param string $html HTML contents to wrap.
1090 * @return string Wrapped HTML.
1092 public function wrapForm( $html ) {
1093 # Include a <fieldset> wrapper for style, if requested.
1094 if ( $this->mWrapperLegend
!== false ) {
1095 $legend = is_string( $this->mWrapperLegend
) ?
$this->mWrapperLegend
: false;
1096 $html = Xml
::fieldset( $legend, $html );
1099 return Html
::rawElement(
1101 $this->getFormAttributes(),
1107 * Get the hidden fields that should go inside the form.
1108 * @return string HTML.
1110 public function getHiddenFields() {
1112 if ( $this->mFormIdentifier
!== null ) {
1113 $html .= Html
::hidden(
1115 $this->mFormIdentifier
1118 if ( $this->getMethod() === 'post' ) {
1119 $html .= Html
::hidden(
1121 $this->getUser()->getEditToken( $this->mTokenSalt
),
1122 [ 'id' => 'wpEditToken' ]
1124 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1127 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1128 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1129 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1132 foreach ( $this->mHiddenFields
as $data ) {
1133 list( $value, $attribs ) = $data;
1134 $html .= Html
::hidden( $attribs['name'], $value, $attribs ) . "\n";
1141 * Get the submit and (potentially) reset buttons.
1142 * @return string HTML.
1144 public function getButtons() {
1146 $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1148 if ( $this->mShowSubmit
) {
1151 if ( isset( $this->mSubmitID
) ) {
1152 $attribs['id'] = $this->mSubmitID
;
1155 if ( isset( $this->mSubmitName
) ) {
1156 $attribs['name'] = $this->mSubmitName
;
1159 if ( isset( $this->mSubmitTooltip
) ) {
1160 $attribs +
= Linker
::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip
);
1163 $attribs['class'] = [ 'mw-htmlform-submit' ];
1165 if ( $useMediaWikiUIEverywhere ) {
1166 foreach ( $this->mSubmitFlags
as $flag ) {
1167 $attribs['class'][] = 'mw-ui-' . $flag;
1169 $attribs['class'][] = 'mw-ui-button';
1172 $buttons .= Xml
::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1175 if ( $this->mShowReset
) {
1176 $buttons .= Html
::element(
1180 'value' => $this->msg( 'htmlform-reset' )->text(),
1181 'class' => $useMediaWikiUIEverywhere ?
'mw-ui-button' : null,
1186 if ( $this->mShowCancel
) {
1187 $target = $this->mCancelTarget ?
: Title
::newMainPage();
1188 if ( $target instanceof Title
) {
1189 $target = $target->getLocalURL();
1191 $buttons .= Html
::element(
1194 'class' => $useMediaWikiUIEverywhere ?
'mw-ui-button' : null,
1197 $this->msg( 'cancel' )->text()
1201 // IE<8 has bugs with <button>, so we'll need to avoid them.
1202 $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1204 foreach ( $this->mButtons
as $button ) {
1207 'name' => $button['name'],
1208 'value' => $button['value']
1211 if ( isset( $button['label-message'] ) ) {
1212 $label = $this->getMessage( $button['label-message'] )->parse();
1213 } elseif ( isset( $button['label'] ) ) {
1214 $label = htmlspecialchars( $button['label'] );
1215 } elseif ( isset( $button['label-raw'] ) ) {
1216 $label = $button['label-raw'];
1218 $label = htmlspecialchars( $button['value'] );
1221 if ( $button['attribs'] ) {
1222 $attrs +
= $button['attribs'];
1225 if ( isset( $button['id'] ) ) {
1226 $attrs['id'] = $button['id'];
1229 if ( $useMediaWikiUIEverywhere ) {
1230 $attrs['class'] = isset( $attrs['class'] ) ?
(array)$attrs['class'] : [];
1231 $attrs['class'][] = 'mw-ui-button';
1235 $buttons .= Html
::element( 'input', $attrs ) . "\n";
1237 $buttons .= Html
::rawElement( 'button', $attrs, $label ) . "\n";
1245 return Html
::rawElement( 'span',
1246 [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1250 * Get the whole body of the form.
1253 public function getBody() {
1254 return $this->displaySection( $this->mFieldTree
, $this->mTableId
);
1258 * Format and display an error message stack.
1260 * @param string|array|Status $errors
1262 * @deprecated since 1.28, use getErrorsOrWarnings() instead
1266 public function getErrors( $errors ) {
1267 wfDeprecated( __METHOD__
);
1268 return $this->getErrorsOrWarnings( $errors, 'error' );
1272 * Returns a formatted list of errors or warnings from the given elements.
1274 * @param string|array|Status $elements The set of errors/warnings to process.
1275 * @param string $elementsType Should warnings or errors be returned. This is meant
1276 * for Status objects, all other valid types are always considered as errors.
1279 public function getErrorsOrWarnings( $elements, $elementsType ) {
1280 if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1281 throw new DomainException( $elementsType . ' is not a valid type.' );
1283 $elementstr = false;
1284 if ( $elements instanceof Status
) {
1285 list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1286 $status = $elementsType === 'error' ?
$errorStatus : $warningStatus;
1287 if ( $status->isGood() ) {
1290 $elementstr = $this->getOutput()->parse(
1291 $status->getWikiText()
1294 } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1295 $elementstr = $this->formatErrors( $elements );
1296 } elseif ( $elementsType === 'error' ) {
1297 $elementstr = $elements;
1301 ? Html
::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1306 * Format a stack of error messages into a single HTML string
1308 * @param array $errors Array of message keys/values
1310 * @return string HTML, a "<ul>" list of errors
1312 public function formatErrors( $errors ) {
1315 foreach ( $errors as $error ) {
1316 $errorstr .= Html
::rawElement(
1319 $this->getMessage( $error )->parse()
1323 $errorstr = Html
::rawElement( 'ul', [], $errorstr );
1329 * Set the text for the submit button
1331 * @param string $t Plaintext
1333 * @return HTMLForm $this for chaining calls (since 1.20)
1335 public function setSubmitText( $t ) {
1336 $this->mSubmitText
= $t;
1342 * Identify that the submit button in the form has a destructive action
1345 * @return HTMLForm $this for chaining calls (since 1.28)
1347 public function setSubmitDestructive() {
1348 $this->mSubmitFlags
= [ 'destructive', 'primary' ];
1354 * Identify that the submit button in the form has a progressive action
1356 * @deprecated since 1.32, No need to call. Submit button already
1357 * has a progressive action form.
1359 * @return HTMLForm $this for chaining calls (since 1.28)
1361 public function setSubmitProgressive() {
1362 wfDeprecated( __METHOD__
, '1.32' );
1363 $this->mSubmitFlags
= [ 'progressive', 'primary' ];
1369 * Set the text for the submit button to a message
1372 * @param string|Message $msg Message key or Message object
1374 * @return HTMLForm $this for chaining calls (since 1.20)
1376 public function setSubmitTextMsg( $msg ) {
1377 if ( !$msg instanceof Message
) {
1378 $msg = $this->msg( $msg );
1380 $this->setSubmitText( $msg->text() );
1386 * Get the text for the submit button, either customised or a default.
1389 public function getSubmitText() {
1390 return $this->mSubmitText ?
: $this->msg( 'htmlform-submit' )->text();
1394 * @param string $name Submit button name
1396 * @return HTMLForm $this for chaining calls (since 1.20)
1398 public function setSubmitName( $name ) {
1399 $this->mSubmitName
= $name;
1405 * @param string $name Tooltip for the submit button
1407 * @return HTMLForm $this for chaining calls (since 1.20)
1409 public function setSubmitTooltip( $name ) {
1410 $this->mSubmitTooltip
= $name;
1416 * Set the id for the submit button.
1420 * @todo FIXME: Integrity of $t is *not* validated
1421 * @return HTMLForm $this for chaining calls (since 1.20)
1423 public function setSubmitID( $t ) {
1424 $this->mSubmitID
= $t;
1430 * Set an internal identifier for this form. It will be submitted as a hidden form field, allowing
1431 * HTMLForm to determine whether the form was submitted (or merely viewed). Setting this serves
1434 * - If you use two or more forms on one page, it allows HTMLForm to identify which of the forms
1435 * was submitted, and not attempt to validate the other ones.
1436 * - If you use checkbox or multiselect fields inside a form using the GET method, it allows
1437 * HTMLForm to distinguish between the initial page view and a form submission with all
1438 * checkboxes or select options unchecked.
1441 * @param string $ident
1444 public function setFormIdentifier( $ident ) {
1445 $this->mFormIdentifier
= $ident;
1451 * Stop a default submit button being shown for this form. This implies that an
1452 * alternate submit method must be provided manually.
1456 * @param bool $suppressSubmit Set to false to re-enable the button again
1458 * @return HTMLForm $this for chaining calls
1460 public function suppressDefaultSubmit( $suppressSubmit = true ) {
1461 $this->mShowSubmit
= !$suppressSubmit;
1467 * Show a cancel button (or prevent it). The button is not shown by default.
1469 * @return HTMLForm $this for chaining calls
1472 public function showCancel( $show = true ) {
1473 $this->mShowCancel
= $show;
1478 * Sets the target where the user is redirected to after clicking cancel.
1479 * @param Title|string $target Target as a Title object or an URL
1480 * @return HTMLForm $this for chaining calls
1483 public function setCancelTarget( $target ) {
1484 $this->mCancelTarget
= $target;
1489 * Set the id of the \<table\> or outermost \<div\> element.
1493 * @param string $id New value of the id attribute, or "" to remove
1495 * @return HTMLForm $this for chaining calls
1497 public function setTableId( $id ) {
1498 $this->mTableId
= $id;
1504 * @param string $id DOM id for the form
1506 * @return HTMLForm $this for chaining calls (since 1.20)
1508 public function setId( $id ) {
1515 * @param string $name 'name' attribute for the form
1516 * @return HTMLForm $this for chaining calls
1518 public function setName( $name ) {
1519 $this->mName
= $name;
1525 * Prompt the whole form to be wrapped in a "<fieldset>", with
1526 * this text as its "<legend>" element.
1528 * @param string|bool $legend If false, no wrapper or legend will be displayed.
1529 * If true, a wrapper will be displayed, but no legend.
1530 * If a string, a wrapper will be displayed with that string as a legend.
1531 * The string will be escaped before being output (this doesn't support HTML).
1533 * @return HTMLForm $this for chaining calls (since 1.20)
1535 public function setWrapperLegend( $legend ) {
1536 $this->mWrapperLegend
= $legend;
1542 * Prompt the whole form to be wrapped in a "<fieldset>", with
1543 * this message as its "<legend>" element.
1546 * @param string|Message $msg Message key or Message object
1548 * @return HTMLForm $this for chaining calls (since 1.20)
1550 public function setWrapperLegendMsg( $msg ) {
1551 if ( !$msg instanceof Message
) {
1552 $msg = $this->msg( $msg );
1554 $this->setWrapperLegend( $msg->text() );
1560 * Set the prefix for various default messages
1561 * @todo Currently only used for the "<fieldset>" legend on forms
1562 * with multiple sections; should be used elsewhere?
1566 * @return HTMLForm $this for chaining calls (since 1.20)
1568 public function setMessagePrefix( $p ) {
1569 $this->mMessagePrefix
= $p;
1575 * Set the title for form submission
1577 * @param Title $t Title of page the form is on/should be posted to
1579 * @return HTMLForm $this for chaining calls (since 1.20)
1581 public function setTitle( $t ) {
1591 public function getTitle() {
1592 return $this->mTitle
=== false
1593 ?
$this->getContext()->getTitle()
1598 * Set the method used to submit the form
1600 * @param string $method
1602 * @return HTMLForm $this for chaining calls (since 1.20)
1604 public function setMethod( $method = 'post' ) {
1605 $this->mMethod
= strtolower( $method );
1611 * @return string Always lowercase
1613 public function getMethod() {
1614 return $this->mMethod
;
1618 * Wraps the given $section into an user-visible fieldset.
1620 * @param string $legend Legend text for the fieldset
1621 * @param string $section The section content in plain Html
1622 * @param array $attributes Additional attributes for the fieldset
1623 * @param bool $isRoot Section is at the root of the tree
1624 * @return string The fieldset's Html
1626 protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1627 return Xml
::fieldset( $legend, $section, $attributes ) . "\n";
1633 * @param array[]|HTMLFormField[] $fields Array of fields (either arrays or
1635 * @param string $sectionName ID attribute of the "<table>" tag for this
1636 * section, ignored if empty.
1637 * @param string $fieldsetIDPrefix ID prefix for the "<fieldset>" tag of
1638 * each subsection, ignored if empty.
1639 * @param bool &$hasUserVisibleFields Whether the section had user-visible fields.
1640 * @throws LogicException When called on uninitialized field data, e.g. When
1641 * HTMLForm::displayForm was called without calling HTMLForm::prepareForm
1646 public function displaySection( $fields,
1648 $fieldsetIDPrefix = '',
1649 &$hasUserVisibleFields = false
1651 if ( $this->mFieldData
=== null ) {
1652 throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1653 . 'You probably called displayForm() without calling prepareForm() first.' );
1656 $displayFormat = $this->getDisplayFormat();
1659 $subsectionHtml = '';
1662 // Conveniently, PHP method names are case-insensitive.
1663 // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1664 $getFieldHtmlMethod = $displayFormat === 'table' ?
'getTableRow' : ( 'get' . $displayFormat );
1666 foreach ( $fields as $key => $value ) {
1667 if ( $value instanceof HTMLFormField
) {
1668 $v = array_key_exists( $key, $this->mFieldData
)
1669 ?
$this->mFieldData
[$key]
1670 : $value->getDefault();
1672 $retval = $value->$getFieldHtmlMethod( $v );
1674 // check, if the form field should be added to
1676 if ( $value->hasVisibleOutput() ) {
1679 $labelValue = trim( $value->getLabel() );
1680 if ( $labelValue !== "\u{00A0}" && $labelValue !== ' ' && $labelValue !== '' ) {
1684 $hasUserVisibleFields = true;
1686 } elseif ( is_array( $value ) ) {
1687 $subsectionHasVisibleFields = false;
1689 $this->displaySection( $value,
1691 "$fieldsetIDPrefix$key-",
1692 $subsectionHasVisibleFields );
1695 if ( $subsectionHasVisibleFields === true ) {
1696 // Display the section with various niceties.
1697 $hasUserVisibleFields = true;
1699 $legend = $this->getLegend( $key );
1701 $section = $this->getHeaderText( $key ) .
1703 $this->getFooterText( $key );
1706 if ( $fieldsetIDPrefix ) {
1707 $attributes['id'] = Sanitizer
::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1709 $subsectionHtml .= $this->wrapFieldSetSection(
1710 $legend, $section, $attributes, $fields === $this->mFieldTree
1713 // Just return the inputs, nothing fancy.
1714 $subsectionHtml .= $section;
1719 $html = $this->formatSection( $html, $sectionName, $hasLabel );
1721 if ( $subsectionHtml ) {
1722 if ( $this->mSubSectionBeforeFields
) {
1723 return $subsectionHtml . "\n" . $html;
1725 return $html . "\n" . $subsectionHtml;
1733 * Put a form section together from the individual fields' HTML, merging it and wrapping.
1734 * @param array $fieldsHtml
1735 * @param string $sectionName
1736 * @param bool $anyFieldHasLabel
1737 * @return string HTML
1739 protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1740 if ( !$fieldsHtml ) {
1741 // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1742 // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1746 $displayFormat = $this->getDisplayFormat();
1747 $html = implode( '', $fieldsHtml );
1749 if ( $displayFormat === 'raw' ) {
1755 if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1756 $classes[] = 'mw-htmlform-nolabel';
1760 'class' => implode( ' ', $classes ),
1763 if ( $sectionName ) {
1764 $attribs['id'] = Sanitizer
::escapeIdForAttribute( $sectionName );
1767 if ( $displayFormat === 'table' ) {
1768 return Html
::rawElement( 'table',
1770 Html
::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1771 } elseif ( $displayFormat === 'inline' ) {
1772 return Html
::rawElement( 'span', $attribs, "\n$html\n" );
1774 return Html
::rawElement( 'div', $attribs, "\n$html\n" );
1779 * Construct the form fields from the Descriptor array
1781 public function loadData() {
1784 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1785 $request = $this->getRequest();
1786 if ( $field->skipLoadData( $request ) ) {
1788 } elseif ( !empty( $field->mParams
['disabled'] ) ) {
1789 $fieldData[$fieldname] = $field->getDefault();
1791 $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1796 foreach ( $fieldData as $name => &$value ) {
1797 $field = $this->mFlatFields
[$name];
1798 $value = $field->filter( $value, $this->mFlatFields
);
1801 $this->mFieldData
= $fieldData;
1805 * Stop a reset button being shown for this form
1807 * @param bool $suppressReset Set to false to re-enable the button again
1809 * @return HTMLForm $this for chaining calls (since 1.20)
1811 public function suppressReset( $suppressReset = true ) {
1812 $this->mShowReset
= !$suppressReset;
1818 * Overload this if you want to apply special filtration routines
1819 * to the form as a whole, after it's submitted but before it's
1822 * @param array $data
1826 public function filterDataForSubmit( $data ) {
1831 * Get a string to go in the "<legend>" of a section fieldset.
1832 * Override this if you want something more complicated.
1834 * @param string $key
1836 * @return string Plain text (not HTML-escaped)
1838 public function getLegend( $key ) {
1839 return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1843 * Set the value for the action attribute of the form.
1844 * When set to false (which is the default state), the set title is used.
1848 * @param string|bool $action
1850 * @return HTMLForm $this for chaining calls (since 1.20)
1852 public function setAction( $action ) {
1853 $this->mAction
= $action;
1859 * Get the value for the action attribute of the form.
1865 public function getAction() {
1866 // If an action is alredy provided, return it
1867 if ( $this->mAction
!== false ) {
1868 return $this->mAction
;
1871 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1872 // Check whether we are in GET mode and the ArticlePath contains a "?"
1873 // meaning that getLocalURL() would return something like "index.php?title=...".
1874 // As browser remove the query string before submitting GET forms,
1875 // it means that the title would be lost. In such case use wfScript() instead
1876 // and put title in an hidden field (see getHiddenFields()).
1877 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1881 return $this->getTitle()->getLocalURL();
1885 * Set the value for the autocomplete attribute of the form. A typical value is "off".
1886 * When set to null (which is the default state), the attribute get not set.
1890 * @param string|null $autocomplete
1892 * @return HTMLForm $this for chaining calls
1894 public function setAutocomplete( $autocomplete ) {
1895 $this->mAutocomplete
= $autocomplete;
1901 * Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a
1902 * name + parameters array) into a Message.
1903 * @param mixed $value
1906 protected function getMessage( $value ) {
1907 return Message
::newFromSpecifier( $value )->setContext( $this );
1911 * Whether this form, with its current fields, requires the user agent to have JavaScript enabled
1912 * for the client-side HTML5 form validation to work correctly. If this function returns true, a
1913 * 'novalidate' attribute will be added on the `<form>` element. It will be removed if the user
1914 * agent has JavaScript support, in htmlform.js.
1919 public function needsJSForHtml5FormValidation() {
1920 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1921 if ( $field->needsJSForHtml5FormValidation() ) {