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
25 * Object handling generic submission, CSRF protection, layout and
26 * other logic for UI forms. in a reusable manner.
28 * In order to generate the form, the HTMLForm object takes an array
29 * structure detailing the form fields available. Each element of the
30 * array is a basic property-list, including the type of field, the
31 * label it is to be given in the form, callbacks for validation and
32 * 'filtering', and other pertinent information.
34 * Field types are implemented as subclasses of the generic HTMLFormField
35 * object, and typically implement at least getInputHTML, which generates
36 * the HTML for the input field to be placed in the table.
38 * You can find extensive documentation on the www.mediawiki.org wiki:
39 * - https://www.mediawiki.org/wiki/HTMLForm
40 * - https://www.mediawiki.org/wiki/HTMLForm/tutorial
42 * The constructor input is an associative array of $fieldname => $info,
43 * where $info is an Associative Array with any of the following:
45 * 'class' -- the subclass of HTMLFormField that will be used
46 * to create the object. *NOT* the CSS class!
47 * 'type' -- roughly translates into the <select> type attribute.
48 * if 'class' is not specified, this is used as a map
49 * through HTMLForm::$typeMappings to get the class name.
50 * 'default' -- default value when the form is displayed
51 * 'id' -- HTML id attribute
52 * 'cssclass' -- CSS class
53 * 'csshelpclass' -- CSS class used to style help text
54 * 'options' -- associative array mapping labels to values.
55 * Some field types support multi-level arrays.
56 * 'options-messages' -- associative array mapping message keys to values.
57 * Some field types support multi-level arrays.
58 * 'options-message' -- message key to be parsed to extract the list of
59 * options (like 'ipbreason-dropdown').
60 * 'label-message' -- message key for a message to use as the label.
61 * can be an array of msg key and then parameters to
63 * 'label' -- alternatively, a raw text message. Overridden by
65 * 'help' -- message text for a message to use as a help text.
66 * 'help-message' -- message key for a message to use as a help text.
67 * can be an array of msg key and then parameters to
69 * Overwrites 'help-messages' and 'help'.
70 * 'help-messages' -- array of message key. As above, each item can
71 * be an array of msg key and then parameters.
73 * 'required' -- passed through to the object, indicating that it
74 * is a required field.
75 * 'size' -- the length of text fields
76 * 'filter-callback -- a function name to give you the chance to
77 * massage the inputted value before it's processed.
78 * @see HTMLForm::filter()
79 * 'validation-callback' -- a function name to give you the chance
80 * to impose extra validation on the field input.
81 * @see HTMLForm::validate()
82 * 'name' -- By default, the 'name' attribute of the input field
83 * is "wp{$fieldname}". If you want a different name
84 * (eg one without the "wp" prefix), specify it here and
85 * it will be used without modification.
87 * Since 1.20, you can chain mutators to ease the form generation:
90 * $form = new HTMLForm( $someFields );
91 * $form->setMethod( 'get' )
92 * ->setWrapperLegendMsg( 'message-key' )
94 * ->displayForm( '' );
96 * Note that you will have prepareForm and displayForm at the end. Other
97 * methods call done after that would simply not be part of the form :(
99 * @todo Document 'section' / 'subsection' stuff
101 class HTMLForm
extends ContextSource
{
102 // A mapping of 'type' inputs onto standard HTMLFormField subclasses
103 public static $typeMappings = array(
104 'api' => 'HTMLApiField',
105 'text' => 'HTMLTextField',
106 'textarea' => 'HTMLTextAreaField',
107 'select' => 'HTMLSelectField',
108 'radio' => 'HTMLRadioField',
109 'multiselect' => 'HTMLMultiSelectField',
110 'check' => 'HTMLCheckField',
111 'toggle' => 'HTMLCheckField',
112 'int' => 'HTMLIntField',
113 'float' => 'HTMLFloatField',
114 'info' => 'HTMLInfoField',
115 'selectorother' => 'HTMLSelectOrOtherField',
116 'selectandother' => 'HTMLSelectAndOtherField',
117 'submit' => 'HTMLSubmitField',
118 'hidden' => 'HTMLHiddenField',
119 'edittools' => 'HTMLEditTools',
120 'checkmatrix' => 'HTMLCheckMatrix',
121 'cloner' => 'HTMLFormFieldCloner',
122 // HTMLTextField will output the correct type="" attribute automagically.
123 // There are about four zillion other HTML5 input types, like range, but
124 // we don't use those at the moment, so no point in adding all of them.
125 'email' => 'HTMLTextField',
126 'password' => 'HTMLTextField',
127 'url' => 'HTMLTextField',
132 protected $mMessagePrefix;
134 /** @var HTMLFormField[] */
135 protected $mFlatFields;
137 protected $mFieldTree;
138 protected $mShowReset = false;
139 protected $mShowSubmit = true;
141 protected $mSubmitCallback;
142 protected $mValidationErrorMessage;
144 protected $mPre = '';
145 protected $mHeader = '';
146 protected $mFooter = '';
147 protected $mSectionHeaders = array();
148 protected $mSectionFooters = array();
149 protected $mPost = '';
151 protected $mTableId = '';
153 protected $mSubmitID;
154 protected $mSubmitName;
155 protected $mSubmitText;
156 protected $mSubmitTooltip;
159 protected $mMethod = 'post';
160 protected $mWasSubmitted = false;
163 * Form action URL. false means we will use the URL to set Title
167 protected $mAction = false;
169 protected $mUseMultipart = false;
170 protected $mHiddenFields = array();
171 protected $mButtons = array();
173 protected $mWrapperLegend = false;
176 * Salt for the edit token.
179 protected $mTokenSalt = '';
182 * If true, sections that contain both fields and subsections will
183 * render their subsections before their fields.
185 * Subclasses may set this to false to render subsections after fields
188 protected $mSubSectionBeforeFields = true;
191 * Format in which to display form. For viable options,
192 * @see $availableDisplayFormats
195 protected $displayFormat = 'table';
198 * Available formats in which to display the form
201 protected $availableDisplayFormats = array(
209 * Build a new HTMLForm from an array of field attributes
211 * @param array $descriptor Array of Field constructs, as described above
212 * @param IContextSource $context Available since 1.18, will become compulsory in 1.18.
213 * Obviates the need to call $form->setTitle()
214 * @param string $messagePrefix A prefix to go in front of default messages
216 public function __construct( $descriptor, /*IContextSource*/ $context = null,
219 if ( $context instanceof IContextSource
) {
220 $this->setContext( $context );
221 $this->mTitle
= false; // We don't need them to set a title
222 $this->mMessagePrefix
= $messagePrefix;
223 } elseif ( is_null( $context ) && $messagePrefix !== '' ) {
224 $this->mMessagePrefix
= $messagePrefix;
225 } elseif ( is_string( $context ) && $messagePrefix === '' ) {
227 // it's actually $messagePrefix
228 $this->mMessagePrefix
= $context;
231 // Expand out into a tree.
232 $loadedDescriptor = array();
233 $this->mFlatFields
= array();
235 foreach ( $descriptor as $fieldname => $info ) {
236 $section = isset( $info['section'] )
240 if ( isset( $info['type'] ) && $info['type'] == 'file' ) {
241 $this->mUseMultipart
= true;
244 $field = self
::loadInputFromParameters( $fieldname, $info );
245 // FIXME During field's construct, the parent form isn't available!
246 // could add a 'parent' name-value to $info, could add a third parameter.
247 $field->mParent
= $this;
249 // vform gets too much space if empty labels generate HTML.
250 if ( $this->isVForm() ) {
251 $field->setShowEmptyLabel( false );
254 $setSection =& $loadedDescriptor;
256 $sectionParts = explode( '/', $section );
258 while ( count( $sectionParts ) ) {
259 $newName = array_shift( $sectionParts );
261 if ( !isset( $setSection[$newName] ) ) {
262 $setSection[$newName] = array();
265 $setSection =& $setSection[$newName];
269 $setSection[$fieldname] = $field;
270 $this->mFlatFields
[$fieldname] = $field;
273 $this->mFieldTree
= $loadedDescriptor;
277 * Set format in which to display the form
279 * @param string $format The name of the format to use, must be one of
280 * $this->availableDisplayFormats
282 * @throws MWException
284 * @return HTMLForm $this for chaining calls (since 1.20)
286 public function setDisplayFormat( $format ) {
287 if ( !in_array( $format, $this->availableDisplayFormats
) ) {
288 throw new MWException( 'Display format must be one of ' .
289 print_r( $this->availableDisplayFormats
, true ) );
291 $this->displayFormat
= $format;
297 * Getter for displayFormat
301 public function getDisplayFormat() {
302 global $wgHTMLFormAllowTableFormat;
303 $format = $this->displayFormat
;
304 if ( !$wgHTMLFormAllowTableFormat && $format === 'table' ) {
311 * Test if displayFormat is 'vform'
315 public function isVForm() {
316 return $this->displayFormat
=== 'vform';
320 * Get the HTMLFormField subclass for this descriptor.
322 * The descriptor can be passed either 'class' which is the name of
323 * a HTMLFormField subclass, or a shorter 'type' which is an alias.
324 * This makes sure the 'class' is always set, and also is returned by
325 * this function for ease.
329 * @param string $fieldname Name of the field
330 * @param array $descriptor Input Descriptor, as described above
332 * @throws MWException
333 * @return string Name of a HTMLFormField subclass
335 public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
336 if ( isset( $descriptor['class'] ) ) {
337 $class = $descriptor['class'];
338 } elseif ( isset( $descriptor['type'] ) ) {
339 $class = self
::$typeMappings[$descriptor['type']];
340 $descriptor['class'] = $class;
346 throw new MWException( "Descriptor with no class for $fieldname: "
347 . print_r( $descriptor, true ) );
354 * Initialise a new Object for the field
356 * @param string $fieldname Name of the field
357 * @param array $descriptor Input Descriptor, as described above
359 * @throws MWException
360 * @return HTMLFormField Instance of a subclass of HTMLFormField
362 public static function loadInputFromParameters( $fieldname, $descriptor ) {
363 $class = self
::getClassFromDescriptor( $fieldname, $descriptor );
365 $descriptor['fieldname'] = $fieldname;
367 # @todo This will throw a fatal error whenever someone try to use
368 # 'class' to feed a CSS class instead of 'cssclass'. Would be
369 # great to avoid the fatal error and show a nice error.
370 $obj = new $class( $descriptor );
376 * Prepare form for submission.
378 * @attention When doing method chaining, that should be the very last
379 * method call before displayForm().
381 * @throws MWException
382 * @return HTMLForm $this for chaining calls (since 1.20)
384 function prepareForm() {
385 # Check if we have the info we need
386 if ( !$this->mTitle
instanceof Title
&& $this->mTitle
!== false ) {
387 throw new MWException( "You must call setTitle() on an HTMLForm" );
390 # Load data from the request.
397 * Try submitting, with edit token check first
398 * @return Status|bool
400 function tryAuthorizedSubmit() {
404 if ( $this->getMethod() != 'post' ) {
405 $submit = true; // no session check needed
406 } elseif ( $this->getRequest()->wasPosted() ) {
407 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
408 if ( $this->getUser()->isLoggedIn() ||
$editToken != null ) {
409 // Session tokens for logged-out users have no security value.
410 // However, if the user gave one, check it in order to give a nice
411 // "session expired" error instead of "permission denied" or such.
412 $submit = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt
);
419 $this->mWasSubmitted
= true;
420 $result = $this->trySubmit();
427 * The here's-one-I-made-earlier option: do the submission if
428 * posted, or display the form with or without funky validation
430 * @return bool|Status Whether submission was successful.
433 $this->prepareForm();
435 $result = $this->tryAuthorizedSubmit();
436 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ) {
440 $this->displayForm( $result );
446 * Validate all the fields, and call the submission callback
447 * function if everything is kosher.
448 * @throws MWException
449 * @return bool|string|array|Status
450 * - Bool true or a good Status object indicates success,
451 * - Bool false indicates no submission was attempted,
452 * - Anything else indicates failure. The value may be a fatal Status
453 * object, an HTML string, or an array of arrays (message keys and
454 * params) or strings (message keys)
456 function trySubmit() {
457 $this->mWasSubmitted
= true;
459 # Check for cancelled submission
460 foreach ( $this->mFlatFields
as $fieldname => $field ) {
461 if ( !empty( $field->mParams
['nodata'] ) ) {
464 if ( $field->cancelSubmit( $this->mFieldData
[$fieldname], $this->mFieldData
) ) {
465 $this->mWasSubmitted
= false;
470 # Check for validation
471 foreach ( $this->mFlatFields
as $fieldname => $field ) {
472 if ( !empty( $field->mParams
['nodata'] ) ) {
475 if ( $field->validate(
476 $this->mFieldData
[$fieldname],
480 return isset( $this->mValidationErrorMessage
)
481 ?
$this->mValidationErrorMessage
482 : array( 'htmlform-invalid-input' );
486 $callback = $this->mSubmitCallback
;
487 if ( !is_callable( $callback ) ) {
488 throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
489 'setSubmitCallback() to set one.' );
492 $data = $this->filterDataForSubmit( $this->mFieldData
);
494 $res = call_user_func( $callback, $data, $this );
495 if ( $res === false ) {
496 $this->mWasSubmitted
= false;
503 * Test whether the form was considered to have been submitted or not, i.e.
504 * whether the last call to tryAuthorizedSubmit or trySubmit returned
507 * This will return false until HTMLForm::tryAuthorizedSubmit or
508 * HTMLForm::trySubmit is called.
513 function wasSubmitted() {
514 return $this->mWasSubmitted
;
518 * Set a callback to a function to do something with the form
519 * once it's been successfully validated.
521 * @param callable $cb The function will be passed the output from
522 * HTMLForm::filterDataForSubmit and this HTMLForm object, and must
523 * return as documented for HTMLForm::trySubmit
525 * @return HTMLForm $this for chaining calls (since 1.20)
527 function setSubmitCallback( $cb ) {
528 $this->mSubmitCallback
= $cb;
534 * Set a message to display on a validation error.
536 * @param string|array $msg String or Array of valid inputs to wfMessage()
537 * (so each entry can be either a String or Array)
539 * @return HTMLForm $this for chaining calls (since 1.20)
541 function setValidationErrorMessage( $msg ) {
542 $this->mValidationErrorMessage
= $msg;
548 * Set the introductory message, overwriting any existing message.
550 * @param string $msg Complete text of message to display
552 * @return HTMLForm $this for chaining calls (since 1.20)
554 function setIntro( $msg ) {
555 $this->setPreText( $msg );
561 * Set the introductory message, overwriting any existing message.
564 * @param string $msg Complete text of message to display
566 * @return HTMLForm $this for chaining calls (since 1.20)
568 function setPreText( $msg ) {
575 * Add introductory text.
577 * @param string $msg Complete text of message to display
579 * @return HTMLForm $this for chaining calls (since 1.20)
581 function addPreText( $msg ) {
588 * Add header text, inside the form.
590 * @param string $msg Complete text of message to display
591 * @param string|null $section The section to add the header to
593 * @return HTMLForm $this for chaining calls (since 1.20)
595 function addHeaderText( $msg, $section = null ) {
596 if ( is_null( $section ) ) {
597 $this->mHeader
.= $msg;
599 if ( !isset( $this->mSectionHeaders
[$section] ) ) {
600 $this->mSectionHeaders
[$section] = '';
602 $this->mSectionHeaders
[$section] .= $msg;
609 * Set header text, inside the form.
612 * @param string $msg Complete text of message to display
613 * @param string|null $section The section to add the header to
615 * @return HTMLForm $this for chaining calls (since 1.20)
617 function setHeaderText( $msg, $section = null ) {
618 if ( is_null( $section ) ) {
619 $this->mHeader
= $msg;
621 $this->mSectionHeaders
[$section] = $msg;
628 * Add footer text, inside the form.
630 * @param string $msg Complete text of message to display
631 * @param string|null $section The section to add the footer text to
633 * @return HTMLForm $this for chaining calls (since 1.20)
635 function addFooterText( $msg, $section = null ) {
636 if ( is_null( $section ) ) {
637 $this->mFooter
.= $msg;
639 if ( !isset( $this->mSectionFooters
[$section] ) ) {
640 $this->mSectionFooters
[$section] = '';
642 $this->mSectionFooters
[$section] .= $msg;
649 * Set footer text, inside the form.
652 * @param string $msg Complete text of message to display
653 * @param string|null $section The section to add the footer text to
655 * @return HTMLForm $this for chaining calls (since 1.20)
657 function setFooterText( $msg, $section = null ) {
658 if ( is_null( $section ) ) {
659 $this->mFooter
= $msg;
661 $this->mSectionFooters
[$section] = $msg;
668 * Add text to the end of the display.
670 * @param string $msg Complete text of message to display
672 * @return HTMLForm $this for chaining calls (since 1.20)
674 function addPostText( $msg ) {
675 $this->mPost
.= $msg;
681 * Set text at the end of the display.
683 * @param string $msg Complete text of message to display
685 * @return HTMLForm $this for chaining calls (since 1.20)
687 function setPostText( $msg ) {
694 * Add a hidden field to the output
696 * @param string $name Field name. This will be used exactly as entered
697 * @param string $value Field value
698 * @param array $attribs
700 * @return HTMLForm $this for chaining calls (since 1.20)
702 public function addHiddenField( $name, $value, $attribs = array() ) {
703 $attribs +
= array( 'name' => $name );
704 $this->mHiddenFields
[] = array( $value, $attribs );
710 * Add an array of hidden fields to the output
714 * @param array $fields Associative array of fields to add;
715 * mapping names to their values
717 * @return HTMLForm $this for chaining calls
719 public function addHiddenFields( array $fields ) {
720 foreach ( $fields as $name => $value ) {
721 $this->mHiddenFields
[] = array( $value, array( 'name' => $name ) );
728 * Add a button to the form
730 * @param string $name Field name.
731 * @param string $value Field value
732 * @param string $id DOM id for the button (default: null)
733 * @param array $attribs
735 * @return HTMLForm $this for chaining calls (since 1.20)
737 public function addButton( $name, $value, $id = null, $attribs = null ) {
738 $this->mButtons
[] = compact( 'name', 'value', 'id', 'attribs' );
744 * Set the salt for the edit token.
746 * Only useful when the method is "post".
749 * @param string|array $salt Salt to use
750 * @return HTMLForm $this For chaining calls
752 public function setTokenSalt( $salt ) {
753 $this->mTokenSalt
= $salt;
759 * Display the form (sending to the context's OutputPage object), with an
760 * appropriate error message or stack of messages, and any validation errors, etc.
762 * @attention You should call prepareForm() before calling this function.
763 * Moreover, when doing method chaining this should be the very last method
764 * call just after prepareForm().
766 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
768 * @return void Nothing, should be last call
770 function displayForm( $submitResult ) {
771 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
775 * Returns the raw HTML generated by the form
777 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
781 function getHTML( $submitResult ) {
782 # For good measure (it is the default)
783 $this->getOutput()->preventClickjacking();
784 $this->getOutput()->addModules( 'mediawiki.htmlform' );
785 if ( $this->isVForm() ) {
786 $this->getOutput()->addModuleStyles( array(
788 'mediawiki.ui.button',
790 // @todo Should vertical form set setWrapperLegend( false )
791 // to hide ugly fieldsets?
795 . $this->getErrors( $submitResult )
798 . $this->getHiddenFields()
799 . $this->getButtons()
802 $html = $this->wrapForm( $html );
804 return '' . $this->mPre
. $html . $this->mPost
;
808 * Wrap the form innards in an actual "<form>" element
810 * @param string $html HTML contents to wrap.
812 * @return string Wrapped HTML.
814 function wrapForm( $html ) {
816 # Include a <fieldset> wrapper for style, if requested.
817 if ( $this->mWrapperLegend
!== false ) {
818 $html = Xml
::fieldset( $this->mWrapperLegend
, $html );
820 # Use multipart/form-data
821 $encType = $this->mUseMultipart
822 ?
'multipart/form-data'
823 : 'application/x-www-form-urlencoded';
826 'action' => $this->getAction(),
827 'method' => $this->getMethod(),
828 'class' => array( 'visualClear' ),
829 'enctype' => $encType,
831 if ( !empty( $this->mId
) ) {
832 $attribs['id'] = $this->mId
;
835 if ( $this->isVForm() ) {
836 array_push( $attribs['class'], 'mw-ui-vform', 'mw-ui-container' );
839 return Html
::rawElement( 'form', $attribs, $html );
843 * Get the hidden fields that should go inside the form.
844 * @return string HTML.
846 function getHiddenFields() {
847 global $wgArticlePath;
850 if ( $this->getMethod() == 'post' ) {
851 $html .= Html
::hidden(
853 $this->getUser()->getEditToken( $this->mTokenSalt
),
854 array( 'id' => 'wpEditToken' )
856 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
859 if ( strpos( $wgArticlePath, '?' ) !== false && $this->getMethod() == 'get' ) {
860 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
863 foreach ( $this->mHiddenFields
as $data ) {
864 list( $value, $attribs ) = $data;
865 $html .= Html
::hidden( $attribs['name'], $value, $attribs ) . "\n";
872 * Get the submit and (potentially) reset buttons.
873 * @return string HTML.
875 function getButtons() {
876 global $wgUseMediaWikiUIEverywhere;
879 if ( $this->mShowSubmit
) {
882 if ( isset( $this->mSubmitID
) ) {
883 $attribs['id'] = $this->mSubmitID
;
886 if ( isset( $this->mSubmitName
) ) {
887 $attribs['name'] = $this->mSubmitName
;
890 if ( isset( $this->mSubmitTooltip
) ) {
891 $attribs +
= Linker
::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip
);
894 $attribs['class'] = array( 'mw-htmlform-submit' );
896 if ( $this->isVForm() ||
$wgUseMediaWikiUIEverywhere ) {
897 array_push( $attribs['class'], 'mw-ui-button', 'mw-ui-constructive' );
900 if ( $this->isVForm() ) {
901 // mw-ui-block is necessary because the buttons aren't necessarily in an
902 // immediate child div of the vform.
903 // @todo Let client specify if the primary submit button is progressive or destructive
911 $buttons .= Xml
::submitButton( $this->getSubmitText(), $attribs ) . "\n";
914 if ( $this->mShowReset
) {
915 $buttons .= Html
::element(
919 'value' => $this->msg( 'htmlform-reset' )->text()
924 foreach ( $this->mButtons
as $button ) {
927 'name' => $button['name'],
928 'value' => $button['value']
931 if ( $button['attribs'] ) {
932 $attrs +
= $button['attribs'];
935 if ( isset( $button['id'] ) ) {
936 $attrs['id'] = $button['id'];
939 if ( $wgUseMediaWikiUIEverywhere ) {
940 if ( isset( $attrs['class' ] ) ) {
941 $attrs['class'] .= ' mw-ui-button';
943 $attrs['class'] = 'mw-ui-button';
947 $buttons .= Html
::element( 'input', $attrs ) . "\n";
950 $html = Html
::rawElement( 'span',
951 array( 'class' => 'mw-htmlform-submit-buttons' ), "\n$buttons" ) . "\n";
953 // Buttons are top-level form elements in table and div layouts,
954 // but vform wants all elements inside divs to get spaced-out block
956 if ( $this->mShowSubmit
&& $this->isVForm() ) {
957 $html = Html
::rawElement( 'div', null, "\n$html" ) . "\n";
964 * Get the whole body of the form.
968 return $this->displaySection( $this->mFieldTree
, $this->mTableId
);
972 * Format and display an error message stack.
974 * @param string|array|Status $errors
978 function getErrors( $errors ) {
979 if ( $errors instanceof Status
) {
980 if ( $errors->isOK() ) {
983 $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
985 } elseif ( is_array( $errors ) ) {
986 $errorstr = $this->formatErrors( $errors );
992 ? Html
::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
997 * Format a stack of error messages into a single HTML string
999 * @param array $errors Array of message keys/values
1001 * @return string HTML, a "<ul>" list of errors
1003 public static function formatErrors( $errors ) {
1006 foreach ( $errors as $error ) {
1007 if ( is_array( $error ) ) {
1008 $msg = array_shift( $error );
1014 $errorstr .= Html
::rawElement(
1017 wfMessage( $msg, $error )->parse()
1021 $errorstr = Html
::rawElement( 'ul', array(), $errorstr );
1027 * Set the text for the submit button
1029 * @param string $t Plaintext
1031 * @return HTMLForm $this for chaining calls (since 1.20)
1033 function setSubmitText( $t ) {
1034 $this->mSubmitText
= $t;
1040 * Set the text for the submit button to a message
1043 * @param string|Message $msg Message key or Message object
1045 * @return HTMLForm $this for chaining calls (since 1.20)
1047 public function setSubmitTextMsg( $msg ) {
1048 if ( !$msg instanceof Message
) {
1049 $msg = $this->msg( $msg );
1051 $this->setSubmitText( $msg->text() );
1057 * Get the text for the submit button, either customised or a default.
1060 function getSubmitText() {
1061 return $this->mSubmitText
1062 ?
$this->mSubmitText
1063 : $this->msg( 'htmlform-submit' )->text();
1067 * @param string $name Submit button name
1069 * @return HTMLForm $this for chaining calls (since 1.20)
1071 public function setSubmitName( $name ) {
1072 $this->mSubmitName
= $name;
1078 * @param string $name Tooltip for the submit button
1080 * @return HTMLForm $this for chaining calls (since 1.20)
1082 public function setSubmitTooltip( $name ) {
1083 $this->mSubmitTooltip
= $name;
1089 * Set the id for the submit button.
1093 * @todo FIXME: Integrity of $t is *not* validated
1094 * @return HTMLForm $this for chaining calls (since 1.20)
1096 function setSubmitID( $t ) {
1097 $this->mSubmitID
= $t;
1103 * Stop a default submit button being shown for this form. This implies that an
1104 * alternate submit method must be provided manually.
1108 * @param bool $suppressSubmit Set to false to re-enable the button again
1110 * @return HTMLForm $this for chaining calls
1112 function suppressDefaultSubmit( $suppressSubmit = true ) {
1113 $this->mShowSubmit
= !$suppressSubmit;
1119 * Set the id of the \<table\> or outermost \<div\> element.
1123 * @param string $id New value of the id attribute, or "" to remove
1125 * @return HTMLForm $this for chaining calls
1127 public function setTableId( $id ) {
1128 $this->mTableId
= $id;
1134 * @param string $id DOM id for the form
1136 * @return HTMLForm $this for chaining calls (since 1.20)
1138 public function setId( $id ) {
1145 * Prompt the whole form to be wrapped in a "<fieldset>", with
1146 * this text as its "<legend>" element.
1148 * @param string|bool $legend HTML to go inside the "<legend>" element, or
1149 * false for no <legend>
1152 * @return HTMLForm $this for chaining calls (since 1.20)
1154 public function setWrapperLegend( $legend ) {
1155 $this->mWrapperLegend
= $legend;
1161 * Prompt the whole form to be wrapped in a "<fieldset>", with
1162 * this message as its "<legend>" element.
1165 * @param string|Message $msg Message key or Message object
1167 * @return HTMLForm $this for chaining calls (since 1.20)
1169 public function setWrapperLegendMsg( $msg ) {
1170 if ( !$msg instanceof Message
) {
1171 $msg = $this->msg( $msg );
1173 $this->setWrapperLegend( $msg->text() );
1179 * Set the prefix for various default messages
1180 * @todo Currently only used for the "<fieldset>" legend on forms
1181 * with multiple sections; should be used elsewhere?
1185 * @return HTMLForm $this for chaining calls (since 1.20)
1187 function setMessagePrefix( $p ) {
1188 $this->mMessagePrefix
= $p;
1194 * Set the title for form submission
1196 * @param Title $t Title of page the form is on/should be posted to
1198 * @return HTMLForm $this for chaining calls (since 1.20)
1200 function setTitle( $t ) {
1210 function getTitle() {
1211 return $this->mTitle
=== false
1212 ?
$this->getContext()->getTitle()
1217 * Set the method used to submit the form
1219 * @param string $method
1221 * @return HTMLForm $this for chaining calls (since 1.20)
1223 public function setMethod( $method = 'post' ) {
1224 $this->mMethod
= $method;
1229 public function getMethod() {
1230 return $this->mMethod
;
1236 * @param array[]|HTMLFormField[] $fields Array of fields (either arrays or
1238 * @param string $sectionName ID attribute of the "<table>" tag for this
1239 * section, ignored if empty.
1240 * @param string $fieldsetIDPrefix ID prefix for the "<fieldset>" tag of
1241 * each subsection, ignored if empty.
1242 * @param bool &$hasUserVisibleFields Whether the section had user-visible fields.
1246 public function displaySection( $fields,
1248 $fieldsetIDPrefix = '',
1249 &$hasUserVisibleFields = false ) {
1250 $displayFormat = $this->getDisplayFormat();
1253 $subsectionHtml = '';
1256 switch ( $displayFormat ) {
1258 $getFieldHtmlMethod = 'getTableRow';
1261 // Close enough to a div.
1262 $getFieldHtmlMethod = 'getDiv';
1265 $getFieldHtmlMethod = 'getDiv';
1268 $getFieldHtmlMethod = 'get' . ucfirst( $displayFormat );
1271 foreach ( $fields as $key => $value ) {
1272 if ( $value instanceof HTMLFormField
) {
1273 $v = empty( $value->mParams
['nodata'] )
1274 ?
$this->mFieldData
[$key]
1275 : $value->getDefault();
1276 $html .= $value->$getFieldHtmlMethod( $v );
1278 $labelValue = trim( $value->getLabel() );
1279 if ( $labelValue != ' ' && $labelValue !== '' ) {
1283 if ( get_class( $value ) !== 'HTMLHiddenField' &&
1284 get_class( $value ) !== 'HTMLApiField'
1286 $hasUserVisibleFields = true;
1288 } elseif ( is_array( $value ) ) {
1289 $subsectionHasVisibleFields = false;
1291 $this->displaySection( $value,
1293 "$fieldsetIDPrefix$key-",
1294 $subsectionHasVisibleFields );
1297 if ( $subsectionHasVisibleFields === true ) {
1298 // Display the section with various niceties.
1299 $hasUserVisibleFields = true;
1301 $legend = $this->getLegend( $key );
1303 if ( isset( $this->mSectionHeaders
[$key] ) ) {
1304 $section = $this->mSectionHeaders
[$key] . $section;
1306 if ( isset( $this->mSectionFooters
[$key] ) ) {
1307 $section .= $this->mSectionFooters
[$key];
1310 $attributes = array();
1311 if ( $fieldsetIDPrefix ) {
1312 $attributes['id'] = Sanitizer
::escapeId( "$fieldsetIDPrefix$key" );
1314 $subsectionHtml .= Xml
::fieldset( $legend, $section, $attributes ) . "\n";
1316 // Just return the inputs, nothing fancy.
1317 $subsectionHtml .= $section;
1322 if ( $displayFormat !== 'raw' ) {
1325 if ( !$hasLabel ) { // Avoid strange spacing when no labels exist
1326 $classes[] = 'mw-htmlform-nolabel';
1330 'class' => implode( ' ', $classes ),
1333 if ( $sectionName ) {
1334 $attribs['id'] = Sanitizer
::escapeId( $sectionName );
1337 if ( $displayFormat === 'table' ) {
1338 $html = Html
::rawElement( 'table',
1340 Html
::rawElement( 'tbody', array(), "\n$html\n" ) ) . "\n";
1341 } elseif ( $displayFormat === 'div' ||
$displayFormat === 'vform' ) {
1342 $html = Html
::rawElement( 'div', $attribs, "\n$html\n" );
1346 if ( $this->mSubSectionBeforeFields
) {
1347 return $subsectionHtml . "\n" . $html;
1349 return $html . "\n" . $subsectionHtml;
1354 * Construct the form fields from the Descriptor array
1356 function loadData() {
1357 $fieldData = array();
1359 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1360 if ( !empty( $field->mParams
['nodata'] ) ) {
1362 } elseif ( !empty( $field->mParams
['disabled'] ) ) {
1363 $fieldData[$fieldname] = $field->getDefault();
1365 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
1370 foreach ( $fieldData as $name => &$value ) {
1371 $field = $this->mFlatFields
[$name];
1372 $value = $field->filter( $value, $this->mFlatFields
);
1375 $this->mFieldData
= $fieldData;
1379 * Stop a reset button being shown for this form
1381 * @param bool $suppressReset Set to false to re-enable the button again
1383 * @return HTMLForm $this for chaining calls (since 1.20)
1385 function suppressReset( $suppressReset = true ) {
1386 $this->mShowReset
= !$suppressReset;
1392 * Overload this if you want to apply special filtration routines
1393 * to the form as a whole, after it's submitted but before it's
1396 * @param array $data
1400 function filterDataForSubmit( $data ) {
1405 * Get a string to go in the "<legend>" of a section fieldset.
1406 * Override this if you want something more complicated.
1408 * @param string $key
1412 public function getLegend( $key ) {
1413 return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1417 * Set the value for the action attribute of the form.
1418 * When set to false (which is the default state), the set title is used.
1422 * @param string|bool $action
1424 * @return HTMLForm $this for chaining calls (since 1.20)
1426 public function setAction( $action ) {
1427 $this->mAction
= $action;
1433 * Get the value for the action attribute of the form.
1439 public function getAction() {
1440 global $wgScript, $wgArticlePath;
1442 // If an action is alredy provided, return it
1443 if ( $this->mAction
!== false ) {
1444 return $this->mAction
;
1447 // Check whether we are in GET mode and $wgArticlePath contains a "?"
1448 // meaning that getLocalURL() would return something like "index.php?title=...".
1449 // As browser remove the query string before submitting GET forms,
1450 // it means that the title would be lost. In such case use $wgScript instead
1451 // and put title in an hidden field (see getHiddenFields()).
1452 if ( strpos( $wgArticlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1456 return $this->getTitle()->getLocalURL();