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 'limitselect' => 'HTMLSelectLimitField',
111 'check' => 'HTMLCheckField',
112 'toggle' => 'HTMLCheckField',
113 'int' => 'HTMLIntField',
114 'float' => 'HTMLFloatField',
115 'info' => 'HTMLInfoField',
116 'selectorother' => 'HTMLSelectOrOtherField',
117 'selectandother' => 'HTMLSelectAndOtherField',
118 'submit' => 'HTMLSubmitField',
119 'hidden' => 'HTMLHiddenField',
120 'edittools' => 'HTMLEditTools',
121 'checkmatrix' => 'HTMLCheckMatrix',
122 'cloner' => 'HTMLFormFieldCloner',
123 // HTMLTextField will output the correct type="" attribute automagically.
124 // There are about four zillion other HTML5 input types, like range, but
125 // we don't use those at the moment, so no point in adding all of them.
126 'email' => 'HTMLTextField',
127 'password' => 'HTMLTextField',
128 'url' => 'HTMLTextField',
133 protected $mMessagePrefix;
135 /** @var HTMLFormField[] */
136 protected $mFlatFields;
138 protected $mFieldTree;
139 protected $mShowReset = false;
140 protected $mShowSubmit = true;
142 protected $mSubmitCallback;
143 protected $mValidationErrorMessage;
145 protected $mPre = '';
146 protected $mHeader = '';
147 protected $mFooter = '';
148 protected $mSectionHeaders = array();
149 protected $mSectionFooters = array();
150 protected $mPost = '';
152 protected $mTableId = '';
154 protected $mSubmitID;
155 protected $mSubmitName;
156 protected $mSubmitText;
157 protected $mSubmitTooltip;
160 protected $mMethod = 'post';
161 protected $mWasSubmitted = false;
164 * Form action URL. false means we will use the URL to set Title
168 protected $mAction = false;
170 protected $mUseMultipart = false;
171 protected $mHiddenFields = array();
172 protected $mButtons = array();
174 protected $mWrapperLegend = false;
177 * Salt for the edit token.
180 protected $mTokenSalt = '';
183 * If true, sections that contain both fields and subsections will
184 * render their subsections before their fields.
186 * Subclasses may set this to false to render subsections after fields
189 protected $mSubSectionBeforeFields = true;
192 * Format in which to display form. For viable options,
193 * @see $availableDisplayFormats
196 protected $displayFormat = 'table';
199 * Available formats in which to display the form
202 protected $availableDisplayFormats = array(
210 * Build a new HTMLForm from an array of field attributes
212 * @param array $descriptor Array of Field constructs, as described above
213 * @param IContextSource $context Available since 1.18, will become compulsory in 1.18.
214 * Obviates the need to call $form->setTitle()
215 * @param string $messagePrefix A prefix to go in front of default messages
217 public function __construct( $descriptor, /*IContextSource*/ $context = null,
220 if ( $context instanceof IContextSource
) {
221 $this->setContext( $context );
222 $this->mTitle
= false; // We don't need them to set a title
223 $this->mMessagePrefix
= $messagePrefix;
224 } elseif ( is_null( $context ) && $messagePrefix !== '' ) {
225 $this->mMessagePrefix
= $messagePrefix;
226 } elseif ( is_string( $context ) && $messagePrefix === '' ) {
228 // it's actually $messagePrefix
229 $this->mMessagePrefix
= $context;
232 // Expand out into a tree.
233 $loadedDescriptor = array();
234 $this->mFlatFields
= array();
236 foreach ( $descriptor as $fieldname => $info ) {
237 $section = isset( $info['section'] )
241 if ( isset( $info['type'] ) && $info['type'] == 'file' ) {
242 $this->mUseMultipart
= true;
245 $field = self
::loadInputFromParameters( $fieldname, $info );
246 // FIXME During field's construct, the parent form isn't available!
247 // could add a 'parent' name-value to $info, could add a third parameter.
248 $field->mParent
= $this;
250 // vform gets too much space if empty labels generate HTML.
251 if ( $this->isVForm() ) {
252 $field->setShowEmptyLabel( false );
255 $setSection =& $loadedDescriptor;
257 $sectionParts = explode( '/', $section );
259 while ( count( $sectionParts ) ) {
260 $newName = array_shift( $sectionParts );
262 if ( !isset( $setSection[$newName] ) ) {
263 $setSection[$newName] = array();
266 $setSection =& $setSection[$newName];
270 $setSection[$fieldname] = $field;
271 $this->mFlatFields
[$fieldname] = $field;
274 $this->mFieldTree
= $loadedDescriptor;
278 * Set format in which to display the form
280 * @param string $format The name of the format to use, must be one of
281 * $this->availableDisplayFormats
283 * @throws MWException
285 * @return HTMLForm $this for chaining calls (since 1.20)
287 public function setDisplayFormat( $format ) {
288 if ( !in_array( $format, $this->availableDisplayFormats
) ) {
289 throw new MWException( 'Display format must be one of ' .
290 print_r( $this->availableDisplayFormats
, true ) );
292 $this->displayFormat
= $format;
298 * Getter for displayFormat
302 public function getDisplayFormat() {
303 global $wgHTMLFormAllowTableFormat;
304 $format = $this->displayFormat
;
305 if ( !$wgHTMLFormAllowTableFormat && $format === 'table' ) {
312 * Test if displayFormat is 'vform'
316 public function isVForm() {
317 return $this->displayFormat
=== 'vform';
321 * Get the HTMLFormField subclass for this descriptor.
323 * The descriptor can be passed either 'class' which is the name of
324 * a HTMLFormField subclass, or a shorter 'type' which is an alias.
325 * This makes sure the 'class' is always set, and also is returned by
326 * this function for ease.
330 * @param string $fieldname Name of the field
331 * @param array $descriptor Input Descriptor, as described above
333 * @throws MWException
334 * @return string Name of a HTMLFormField subclass
336 public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
337 if ( isset( $descriptor['class'] ) ) {
338 $class = $descriptor['class'];
339 } elseif ( isset( $descriptor['type'] ) ) {
340 $class = self
::$typeMappings[$descriptor['type']];
341 $descriptor['class'] = $class;
347 throw new MWException( "Descriptor with no class for $fieldname: "
348 . print_r( $descriptor, true ) );
355 * Initialise a new Object for the field
357 * @param string $fieldname Name of the field
358 * @param array $descriptor Input Descriptor, as described above
360 * @throws MWException
361 * @return HTMLFormField Instance of a subclass of HTMLFormField
363 public static function loadInputFromParameters( $fieldname, $descriptor ) {
364 $class = self
::getClassFromDescriptor( $fieldname, $descriptor );
366 $descriptor['fieldname'] = $fieldname;
368 # @todo This will throw a fatal error whenever someone try to use
369 # 'class' to feed a CSS class instead of 'cssclass'. Would be
370 # great to avoid the fatal error and show a nice error.
371 $obj = new $class( $descriptor );
377 * Prepare form for submission.
379 * @attention When doing method chaining, that should be the very last
380 * method call before displayForm().
382 * @throws MWException
383 * @return HTMLForm $this for chaining calls (since 1.20)
385 function prepareForm() {
386 # Check if we have the info we need
387 if ( !$this->mTitle
instanceof Title
&& $this->mTitle
!== false ) {
388 throw new MWException( "You must call setTitle() on an HTMLForm" );
391 # Load data from the request.
398 * Try submitting, with edit token check first
399 * @return Status|bool
401 function tryAuthorizedSubmit() {
405 if ( $this->getMethod() != 'post' ) {
406 $submit = true; // no session check needed
407 } elseif ( $this->getRequest()->wasPosted() ) {
408 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
409 if ( $this->getUser()->isLoggedIn() ||
$editToken != null ) {
410 // Session tokens for logged-out users have no security value.
411 // However, if the user gave one, check it in order to give a nice
412 // "session expired" error instead of "permission denied" or such.
413 $submit = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt
);
420 $this->mWasSubmitted
= true;
421 $result = $this->trySubmit();
428 * The here's-one-I-made-earlier option: do the submission if
429 * posted, or display the form with or without funky validation
431 * @return bool|Status Whether submission was successful.
434 $this->prepareForm();
436 $result = $this->tryAuthorizedSubmit();
437 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ) {
441 $this->displayForm( $result );
447 * Validate all the fields, and call the submission callback
448 * function if everything is kosher.
449 * @throws MWException
450 * @return bool|string|array|Status
451 * - Bool true or a good Status object indicates success,
452 * - Bool false indicates no submission was attempted,
453 * - Anything else indicates failure. The value may be a fatal Status
454 * object, an HTML string, or an array of arrays (message keys and
455 * params) or strings (message keys)
457 function trySubmit() {
458 $this->mWasSubmitted
= true;
460 # Check for cancelled submission
461 foreach ( $this->mFlatFields
as $fieldname => $field ) {
462 if ( !empty( $field->mParams
['nodata'] ) ) {
465 if ( $field->cancelSubmit( $this->mFieldData
[$fieldname], $this->mFieldData
) ) {
466 $this->mWasSubmitted
= false;
471 # Check for validation
472 foreach ( $this->mFlatFields
as $fieldname => $field ) {
473 if ( !empty( $field->mParams
['nodata'] ) ) {
476 if ( $field->validate(
477 $this->mFieldData
[$fieldname],
481 return isset( $this->mValidationErrorMessage
)
482 ?
$this->mValidationErrorMessage
483 : array( 'htmlform-invalid-input' );
487 $callback = $this->mSubmitCallback
;
488 if ( !is_callable( $callback ) ) {
489 throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
490 'setSubmitCallback() to set one.' );
493 $data = $this->filterDataForSubmit( $this->mFieldData
);
495 $res = call_user_func( $callback, $data, $this );
496 if ( $res === false ) {
497 $this->mWasSubmitted
= false;
504 * Test whether the form was considered to have been submitted or not, i.e.
505 * whether the last call to tryAuthorizedSubmit or trySubmit returned
508 * This will return false until HTMLForm::tryAuthorizedSubmit or
509 * HTMLForm::trySubmit is called.
514 function wasSubmitted() {
515 return $this->mWasSubmitted
;
519 * Set a callback to a function to do something with the form
520 * once it's been successfully validated.
522 * @param callable $cb The function will be passed the output from
523 * HTMLForm::filterDataForSubmit and this HTMLForm object, and must
524 * return as documented for HTMLForm::trySubmit
526 * @return HTMLForm $this for chaining calls (since 1.20)
528 function setSubmitCallback( $cb ) {
529 $this->mSubmitCallback
= $cb;
535 * Set a message to display on a validation error.
537 * @param string|array $msg String or Array of valid inputs to wfMessage()
538 * (so each entry can be either a String or Array)
540 * @return HTMLForm $this for chaining calls (since 1.20)
542 function setValidationErrorMessage( $msg ) {
543 $this->mValidationErrorMessage
= $msg;
549 * Set the introductory message, overwriting any existing message.
551 * @param string $msg Complete text of message to display
553 * @return HTMLForm $this for chaining calls (since 1.20)
555 function setIntro( $msg ) {
556 $this->setPreText( $msg );
562 * Set the introductory message, overwriting any existing message.
565 * @param string $msg Complete text of message to display
567 * @return HTMLForm $this for chaining calls (since 1.20)
569 function setPreText( $msg ) {
576 * Add introductory text.
578 * @param string $msg Complete text of message to display
580 * @return HTMLForm $this for chaining calls (since 1.20)
582 function addPreText( $msg ) {
589 * Add header text, inside the form.
591 * @param string $msg Complete text of message to display
592 * @param string|null $section The section to add the header to
594 * @return HTMLForm $this for chaining calls (since 1.20)
596 function addHeaderText( $msg, $section = null ) {
597 if ( is_null( $section ) ) {
598 $this->mHeader
.= $msg;
600 if ( !isset( $this->mSectionHeaders
[$section] ) ) {
601 $this->mSectionHeaders
[$section] = '';
603 $this->mSectionHeaders
[$section] .= $msg;
610 * Set header text, inside the form.
613 * @param string $msg Complete text of message to display
614 * @param string|null $section The section to add the header to
616 * @return HTMLForm $this for chaining calls (since 1.20)
618 function setHeaderText( $msg, $section = null ) {
619 if ( is_null( $section ) ) {
620 $this->mHeader
= $msg;
622 $this->mSectionHeaders
[$section] = $msg;
629 * Add footer text, inside the form.
631 * @param string $msg Complete text of message to display
632 * @param string|null $section The section to add the footer text to
634 * @return HTMLForm $this for chaining calls (since 1.20)
636 function addFooterText( $msg, $section = null ) {
637 if ( is_null( $section ) ) {
638 $this->mFooter
.= $msg;
640 if ( !isset( $this->mSectionFooters
[$section] ) ) {
641 $this->mSectionFooters
[$section] = '';
643 $this->mSectionFooters
[$section] .= $msg;
650 * Set footer text, inside the form.
653 * @param string $msg Complete text of message to display
654 * @param string|null $section The section to add the footer text to
656 * @return HTMLForm $this for chaining calls (since 1.20)
658 function setFooterText( $msg, $section = null ) {
659 if ( is_null( $section ) ) {
660 $this->mFooter
= $msg;
662 $this->mSectionFooters
[$section] = $msg;
669 * Add text to the end of the display.
671 * @param string $msg Complete text of message to display
673 * @return HTMLForm $this for chaining calls (since 1.20)
675 function addPostText( $msg ) {
676 $this->mPost
.= $msg;
682 * Set text at the end of the display.
684 * @param string $msg Complete text of message to display
686 * @return HTMLForm $this for chaining calls (since 1.20)
688 function setPostText( $msg ) {
695 * Add a hidden field to the output
697 * @param string $name Field name. This will be used exactly as entered
698 * @param string $value Field value
699 * @param array $attribs
701 * @return HTMLForm $this for chaining calls (since 1.20)
703 public function addHiddenField( $name, $value, $attribs = array() ) {
704 $attribs +
= array( 'name' => $name );
705 $this->mHiddenFields
[] = array( $value, $attribs );
711 * Add an array of hidden fields to the output
715 * @param array $fields Associative array of fields to add;
716 * mapping names to their values
718 * @return HTMLForm $this for chaining calls
720 public function addHiddenFields( array $fields ) {
721 foreach ( $fields as $name => $value ) {
722 $this->mHiddenFields
[] = array( $value, array( 'name' => $name ) );
729 * Add a button to the form
731 * @param string $name Field name.
732 * @param string $value Field value
733 * @param string $id DOM id for the button (default: null)
734 * @param array $attribs
736 * @return HTMLForm $this for chaining calls (since 1.20)
738 public function addButton( $name, $value, $id = null, $attribs = null ) {
739 $this->mButtons
[] = compact( 'name', 'value', 'id', 'attribs' );
745 * Set the salt for the edit token.
747 * Only useful when the method is "post".
750 * @param string|array $salt Salt to use
751 * @return HTMLForm $this For chaining calls
753 public function setTokenSalt( $salt ) {
754 $this->mTokenSalt
= $salt;
760 * Display the form (sending to the context's OutputPage object), with an
761 * appropriate error message or stack of messages, and any validation errors, etc.
763 * @attention You should call prepareForm() before calling this function.
764 * Moreover, when doing method chaining this should be the very last method
765 * call just after prepareForm().
767 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
769 * @return void Nothing, should be last call
771 function displayForm( $submitResult ) {
772 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
776 * Returns the raw HTML generated by the form
778 * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
782 function getHTML( $submitResult ) {
783 # For good measure (it is the default)
784 $this->getOutput()->preventClickjacking();
785 $this->getOutput()->addModules( 'mediawiki.htmlform' );
786 if ( $this->isVForm() ) {
787 $this->getOutput()->addModuleStyles( array(
789 'mediawiki.ui.button',
791 // @todo Should vertical form set setWrapperLegend( false )
792 // to hide ugly fieldsets?
796 . $this->getErrors( $submitResult )
799 . $this->getHiddenFields()
800 . $this->getButtons()
803 $html = $this->wrapForm( $html );
805 return '' . $this->mPre
. $html . $this->mPost
;
809 * Wrap the form innards in an actual "<form>" element
811 * @param string $html HTML contents to wrap.
813 * @return string Wrapped HTML.
815 function wrapForm( $html ) {
817 # Include a <fieldset> wrapper for style, if requested.
818 if ( $this->mWrapperLegend
!== false ) {
819 $html = Xml
::fieldset( $this->mWrapperLegend
, $html );
821 # Use multipart/form-data
822 $encType = $this->mUseMultipart
823 ?
'multipart/form-data'
824 : 'application/x-www-form-urlencoded';
827 'action' => $this->getAction(),
828 'method' => $this->getMethod(),
829 'class' => array( 'visualClear' ),
830 'enctype' => $encType,
832 if ( !empty( $this->mId
) ) {
833 $attribs['id'] = $this->mId
;
836 if ( $this->isVForm() ) {
837 array_push( $attribs['class'], 'mw-ui-vform', 'mw-ui-container' );
840 return Html
::rawElement( 'form', $attribs, $html );
844 * Get the hidden fields that should go inside the form.
845 * @return string HTML.
847 function getHiddenFields() {
848 global $wgArticlePath;
851 if ( $this->getMethod() == 'post' ) {
852 $html .= Html
::hidden(
854 $this->getUser()->getEditToken( $this->mTokenSalt
),
855 array( 'id' => 'wpEditToken' )
857 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
860 if ( strpos( $wgArticlePath, '?' ) !== false && $this->getMethod() == 'get' ) {
861 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
864 foreach ( $this->mHiddenFields
as $data ) {
865 list( $value, $attribs ) = $data;
866 $html .= Html
::hidden( $attribs['name'], $value, $attribs ) . "\n";
873 * Get the submit and (potentially) reset buttons.
874 * @return string HTML.
876 function getButtons() {
877 global $wgUseMediaWikiUIEverywhere;
880 if ( $this->mShowSubmit
) {
883 if ( isset( $this->mSubmitID
) ) {
884 $attribs['id'] = $this->mSubmitID
;
887 if ( isset( $this->mSubmitName
) ) {
888 $attribs['name'] = $this->mSubmitName
;
891 if ( isset( $this->mSubmitTooltip
) ) {
892 $attribs +
= Linker
::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip
);
895 $attribs['class'] = array( 'mw-htmlform-submit' );
897 if ( $this->isVForm() ||
$wgUseMediaWikiUIEverywhere ) {
898 array_push( $attribs['class'], 'mw-ui-button', 'mw-ui-constructive' );
901 if ( $this->isVForm() ) {
902 // mw-ui-block is necessary because the buttons aren't necessarily in an
903 // immediate child div of the vform.
904 // @todo Let client specify if the primary submit button is progressive or destructive
912 $buttons .= Xml
::submitButton( $this->getSubmitText(), $attribs ) . "\n";
915 if ( $this->mShowReset
) {
916 $buttons .= Html
::element(
920 'value' => $this->msg( 'htmlform-reset' )->text()
925 foreach ( $this->mButtons
as $button ) {
928 'name' => $button['name'],
929 'value' => $button['value']
932 if ( $button['attribs'] ) {
933 $attrs +
= $button['attribs'];
936 if ( isset( $button['id'] ) ) {
937 $attrs['id'] = $button['id'];
940 if ( $wgUseMediaWikiUIEverywhere ) {
941 if ( isset( $attrs['class' ] ) ) {
942 $attrs['class'] .= ' mw-ui-button';
944 $attrs['class'] = 'mw-ui-button';
948 $buttons .= Html
::element( 'input', $attrs ) . "\n";
951 $html = Html
::rawElement( 'span',
952 array( 'class' => 'mw-htmlform-submit-buttons' ), "\n$buttons" ) . "\n";
954 // Buttons are top-level form elements in table and div layouts,
955 // but vform wants all elements inside divs to get spaced-out block
957 if ( $this->mShowSubmit
&& $this->isVForm() ) {
958 $html = Html
::rawElement( 'div', null, "\n$html" ) . "\n";
965 * Get the whole body of the form.
969 return $this->displaySection( $this->mFieldTree
, $this->mTableId
);
973 * Format and display an error message stack.
975 * @param string|array|Status $errors
979 function getErrors( $errors ) {
980 if ( $errors instanceof Status
) {
981 if ( $errors->isOK() ) {
984 $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
986 } elseif ( is_array( $errors ) ) {
987 $errorstr = $this->formatErrors( $errors );
993 ? Html
::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
998 * Format a stack of error messages into a single HTML string
1000 * @param array $errors Array of message keys/values
1002 * @return string HTML, a "<ul>" list of errors
1004 public static function formatErrors( $errors ) {
1007 foreach ( $errors as $error ) {
1008 if ( is_array( $error ) ) {
1009 $msg = array_shift( $error );
1015 $errorstr .= Html
::rawElement(
1018 wfMessage( $msg, $error )->parse()
1022 $errorstr = Html
::rawElement( 'ul', array(), $errorstr );
1028 * Set the text for the submit button
1030 * @param string $t Plaintext
1032 * @return HTMLForm $this for chaining calls (since 1.20)
1034 function setSubmitText( $t ) {
1035 $this->mSubmitText
= $t;
1041 * Set the text for the submit button to a message
1044 * @param string|Message $msg Message key or Message object
1046 * @return HTMLForm $this for chaining calls (since 1.20)
1048 public function setSubmitTextMsg( $msg ) {
1049 if ( !$msg instanceof Message
) {
1050 $msg = $this->msg( $msg );
1052 $this->setSubmitText( $msg->text() );
1058 * Get the text for the submit button, either customised or a default.
1061 function getSubmitText() {
1062 return $this->mSubmitText
1063 ?
$this->mSubmitText
1064 : $this->msg( 'htmlform-submit' )->text();
1068 * @param string $name Submit button name
1070 * @return HTMLForm $this for chaining calls (since 1.20)
1072 public function setSubmitName( $name ) {
1073 $this->mSubmitName
= $name;
1079 * @param string $name Tooltip for the submit button
1081 * @return HTMLForm $this for chaining calls (since 1.20)
1083 public function setSubmitTooltip( $name ) {
1084 $this->mSubmitTooltip
= $name;
1090 * Set the id for the submit button.
1094 * @todo FIXME: Integrity of $t is *not* validated
1095 * @return HTMLForm $this for chaining calls (since 1.20)
1097 function setSubmitID( $t ) {
1098 $this->mSubmitID
= $t;
1104 * Stop a default submit button being shown for this form. This implies that an
1105 * alternate submit method must be provided manually.
1109 * @param bool $suppressSubmit Set to false to re-enable the button again
1111 * @return HTMLForm $this for chaining calls
1113 function suppressDefaultSubmit( $suppressSubmit = true ) {
1114 $this->mShowSubmit
= !$suppressSubmit;
1120 * Set the id of the \<table\> or outermost \<div\> element.
1124 * @param string $id New value of the id attribute, or "" to remove
1126 * @return HTMLForm $this for chaining calls
1128 public function setTableId( $id ) {
1129 $this->mTableId
= $id;
1135 * @param string $id DOM id for the form
1137 * @return HTMLForm $this for chaining calls (since 1.20)
1139 public function setId( $id ) {
1146 * Prompt the whole form to be wrapped in a "<fieldset>", with
1147 * this text as its "<legend>" element.
1149 * @param string|bool $legend HTML to go inside the "<legend>" element, or
1150 * false for no <legend>
1153 * @return HTMLForm $this for chaining calls (since 1.20)
1155 public function setWrapperLegend( $legend ) {
1156 $this->mWrapperLegend
= $legend;
1162 * Prompt the whole form to be wrapped in a "<fieldset>", with
1163 * this message as its "<legend>" element.
1166 * @param string|Message $msg Message key or Message object
1168 * @return HTMLForm $this for chaining calls (since 1.20)
1170 public function setWrapperLegendMsg( $msg ) {
1171 if ( !$msg instanceof Message
) {
1172 $msg = $this->msg( $msg );
1174 $this->setWrapperLegend( $msg->text() );
1180 * Set the prefix for various default messages
1181 * @todo Currently only used for the "<fieldset>" legend on forms
1182 * with multiple sections; should be used elsewhere?
1186 * @return HTMLForm $this for chaining calls (since 1.20)
1188 function setMessagePrefix( $p ) {
1189 $this->mMessagePrefix
= $p;
1195 * Set the title for form submission
1197 * @param Title $t Title of page the form is on/should be posted to
1199 * @return HTMLForm $this for chaining calls (since 1.20)
1201 function setTitle( $t ) {
1211 function getTitle() {
1212 return $this->mTitle
=== false
1213 ?
$this->getContext()->getTitle()
1218 * Set the method used to submit the form
1220 * @param string $method
1222 * @return HTMLForm $this for chaining calls (since 1.20)
1224 public function setMethod( $method = 'post' ) {
1225 $this->mMethod
= $method;
1230 public function getMethod() {
1231 return $this->mMethod
;
1237 * @param array[]|HTMLFormField[] $fields Array of fields (either arrays or
1239 * @param string $sectionName ID attribute of the "<table>" tag for this
1240 * section, ignored if empty.
1241 * @param string $fieldsetIDPrefix ID prefix for the "<fieldset>" tag of
1242 * each subsection, ignored if empty.
1243 * @param bool &$hasUserVisibleFields Whether the section had user-visible fields.
1247 public function displaySection( $fields,
1249 $fieldsetIDPrefix = '',
1250 &$hasUserVisibleFields = false ) {
1251 $displayFormat = $this->getDisplayFormat();
1254 $subsectionHtml = '';
1257 switch ( $displayFormat ) {
1259 $getFieldHtmlMethod = 'getTableRow';
1262 // Close enough to a div.
1263 $getFieldHtmlMethod = 'getDiv';
1266 $getFieldHtmlMethod = 'getDiv';
1269 $getFieldHtmlMethod = 'get' . ucfirst( $displayFormat );
1272 foreach ( $fields as $key => $value ) {
1273 if ( $value instanceof HTMLFormField
) {
1274 $v = empty( $value->mParams
['nodata'] )
1275 ?
$this->mFieldData
[$key]
1276 : $value->getDefault();
1277 $html .= $value->$getFieldHtmlMethod( $v );
1279 $labelValue = trim( $value->getLabel() );
1280 if ( $labelValue != ' ' && $labelValue !== '' ) {
1284 if ( get_class( $value ) !== 'HTMLHiddenField' &&
1285 get_class( $value ) !== 'HTMLApiField'
1287 $hasUserVisibleFields = true;
1289 } elseif ( is_array( $value ) ) {
1290 $subsectionHasVisibleFields = false;
1292 $this->displaySection( $value,
1294 "$fieldsetIDPrefix$key-",
1295 $subsectionHasVisibleFields );
1298 if ( $subsectionHasVisibleFields === true ) {
1299 // Display the section with various niceties.
1300 $hasUserVisibleFields = true;
1302 $legend = $this->getLegend( $key );
1304 if ( isset( $this->mSectionHeaders
[$key] ) ) {
1305 $section = $this->mSectionHeaders
[$key] . $section;
1307 if ( isset( $this->mSectionFooters
[$key] ) ) {
1308 $section .= $this->mSectionFooters
[$key];
1311 $attributes = array();
1312 if ( $fieldsetIDPrefix ) {
1313 $attributes['id'] = Sanitizer
::escapeId( "$fieldsetIDPrefix$key" );
1315 $subsectionHtml .= Xml
::fieldset( $legend, $section, $attributes ) . "\n";
1317 // Just return the inputs, nothing fancy.
1318 $subsectionHtml .= $section;
1323 if ( $displayFormat !== 'raw' ) {
1326 if ( !$hasLabel ) { // Avoid strange spacing when no labels exist
1327 $classes[] = 'mw-htmlform-nolabel';
1331 'class' => implode( ' ', $classes ),
1334 if ( $sectionName ) {
1335 $attribs['id'] = Sanitizer
::escapeId( $sectionName );
1338 if ( $displayFormat === 'table' ) {
1339 $html = Html
::rawElement( 'table',
1341 Html
::rawElement( 'tbody', array(), "\n$html\n" ) ) . "\n";
1342 } elseif ( $displayFormat === 'div' ||
$displayFormat === 'vform' ) {
1343 $html = Html
::rawElement( 'div', $attribs, "\n$html\n" );
1347 if ( $this->mSubSectionBeforeFields
) {
1348 return $subsectionHtml . "\n" . $html;
1350 return $html . "\n" . $subsectionHtml;
1355 * Construct the form fields from the Descriptor array
1357 function loadData() {
1358 $fieldData = array();
1360 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1361 if ( !empty( $field->mParams
['nodata'] ) ) {
1363 } elseif ( !empty( $field->mParams
['disabled'] ) ) {
1364 $fieldData[$fieldname] = $field->getDefault();
1366 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
1371 foreach ( $fieldData as $name => &$value ) {
1372 $field = $this->mFlatFields
[$name];
1373 $value = $field->filter( $value, $this->mFlatFields
);
1376 $this->mFieldData
= $fieldData;
1380 * Stop a reset button being shown for this form
1382 * @param bool $suppressReset Set to false to re-enable the button again
1384 * @return HTMLForm $this for chaining calls (since 1.20)
1386 function suppressReset( $suppressReset = true ) {
1387 $this->mShowReset
= !$suppressReset;
1393 * Overload this if you want to apply special filtration routines
1394 * to the form as a whole, after it's submitted but before it's
1397 * @param array $data
1401 function filterDataForSubmit( $data ) {
1406 * Get a string to go in the "<legend>" of a section fieldset.
1407 * Override this if you want something more complicated.
1409 * @param string $key
1413 public function getLegend( $key ) {
1414 return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1418 * Set the value for the action attribute of the form.
1419 * When set to false (which is the default state), the set title is used.
1423 * @param string|bool $action
1425 * @return HTMLForm $this for chaining calls (since 1.20)
1427 public function setAction( $action ) {
1428 $this->mAction
= $action;
1434 * Get the value for the action attribute of the form.
1440 public function getAction() {
1441 global $wgScript, $wgArticlePath;
1443 // If an action is alredy provided, return it
1444 if ( $this->mAction
!== false ) {
1445 return $this->mAction
;
1448 // Check whether we are in GET mode and $wgArticlePath contains a "?"
1449 // meaning that getLocalURL() would return something like "index.php?title=...".
1450 // As browser remove the query string before submitting GET forms,
1451 // it means that the title would be lost. In such case use $wgScript instead
1452 // and put title in an hidden field (see getHiddenFields()).
1453 if ( strpos( $wgArticlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1457 return $this->getTitle()->getLocalURL();