3 * HTML form generation and submission handling.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Object handling generic submission, CSRF protection, layout and
25 * other logic for UI forms. in a reusable manner.
27 * In order to generate the form, the HTMLForm object takes an array
28 * structure detailing the form fields available. Each element of the
29 * array is a basic property-list, including the type of field, the
30 * label it is to be given in the form, callbacks for validation and
31 * 'filtering', and other pertinent information.
33 * Field types are implemented as subclasses of the generic HTMLFormField
34 * object, and typically implement at least getInputHTML, which generates
35 * the HTML for the input field to be placed in the table.
37 * You can find extensive documentation on the www.mediawiki.org wiki:
38 * - http://www.mediawiki.org/wiki/HTMLForm
39 * - http://www.mediawiki.org/wiki/HTMLForm/tutorial
41 * The constructor input is an associative array of $fieldname => $info,
42 * where $info is an Associative Array with any of the following:
44 * 'class' -- the subclass of HTMLFormField that will be used
45 * to create the object. *NOT* the CSS class!
46 * 'type' -- roughly translates into the <select> type attribute.
47 * if 'class' is not specified, this is used as a map
48 * through HTMLForm::$typeMappings to get the class name.
49 * 'default' -- default value when the form is displayed
50 * 'id' -- HTML id attribute
51 * 'cssclass' -- CSS class
52 * 'options' -- varies according to the specific object.
53 * 'label-message' -- message key for a message to use as the label.
54 * can be an array of msg key and then parameters to
56 * 'label' -- alternatively, a raw text message. Overridden by
58 * 'help' -- message text for a message to use as a help text.
59 * 'help-message' -- message key for a message to use as a help text.
60 * can be an array of msg key and then parameters to
62 * Overwrites 'help-messages' and 'help'.
63 * 'help-messages' -- array of message key. As above, each item can
64 * be an array of msg key and then parameters.
66 * 'required' -- passed through to the object, indicating that it
67 * is a required field.
68 * 'size' -- the length of text fields
69 * 'filter-callback -- a function name to give you the chance to
70 * massage the inputted value before it's processed.
71 * @see HTMLForm::filter()
72 * 'validation-callback' -- a function name to give you the chance
73 * to impose extra validation on the field input.
74 * @see HTMLForm::validate()
75 * 'name' -- By default, the 'name' attribute of the input field
76 * is "wp{$fieldname}". If you want a different name
77 * (eg one without the "wp" prefix), specify it here and
78 * it will be used without modification.
80 * Since 1.20, you can chain mutators to ease the form generation:
83 * $form = new HTMLForm( $someFields );
84 * $form->setMethod( 'get' )
85 * ->setWrapperLegendMsg( 'message-key' )
90 * Note that you will have prepareForm and displayForm at the end. Other
91 * methods call done after that would simply not be part of the form :(
93 * TODO: Document 'section' / 'subsection' stuff
95 class HTMLForm
extends ContextSource
{
97 // A mapping of 'type' inputs onto standard HTMLFormField subclasses
98 static $typeMappings = array(
99 'text' => 'HTMLTextField',
100 'textarea' => 'HTMLTextAreaField',
101 'select' => 'HTMLSelectField',
102 'radio' => 'HTMLRadioField',
103 'multiselect' => 'HTMLMultiSelectField',
104 'check' => 'HTMLCheckField',
105 'toggle' => 'HTMLCheckField',
106 'int' => 'HTMLIntField',
107 'float' => 'HTMLFloatField',
108 'info' => 'HTMLInfoField',
109 'selectorother' => 'HTMLSelectOrOtherField',
110 'selectandother' => 'HTMLSelectAndOtherField',
111 'submit' => 'HTMLSubmitField',
112 'hidden' => 'HTMLHiddenField',
113 'edittools' => 'HTMLEditTools',
115 // HTMLTextField will output the correct type="" attribute automagically.
116 // There are about four zillion other HTML5 input types, like url, but
117 // we don't use those at the moment, so no point in adding all of them.
118 'email' => 'HTMLTextField',
119 'password' => 'HTMLTextField',
122 protected $mMessagePrefix;
124 /** @var HTMLFormField[] */
125 protected $mFlatFields;
127 protected $mFieldTree;
128 protected $mShowReset = false;
131 protected $mSubmitCallback;
132 protected $mValidationErrorMessage;
134 protected $mPre = '';
135 protected $mHeader = '';
136 protected $mFooter = '';
137 protected $mSectionHeaders = array();
138 protected $mSectionFooters = array();
139 protected $mPost = '';
142 protected $mSubmitID;
143 protected $mSubmitName;
144 protected $mSubmitText;
145 protected $mSubmitTooltip;
148 protected $mMethod = 'post';
151 * Form action URL. false means we will use the URL to set Title
155 protected $mAction = false;
157 protected $mUseMultipart = false;
158 protected $mHiddenFields = array();
159 protected $mButtons = array();
161 protected $mWrapperLegend = false;
164 * If true, sections that contain both fields and subsections will
165 * render their subsections before their fields.
167 * Subclasses may set this to false to render subsections after fields
170 protected $mSubSectionBeforeFields = true;
173 * Format in which to display form. For viable options,
174 * @see $availableDisplayFormats
177 protected $displayFormat = 'table';
180 * Available formats in which to display the form
183 protected $availableDisplayFormats = array(
190 * Build a new HTMLForm from an array of field attributes
191 * @param $descriptor Array of Field constructs, as described above
192 * @param $context IContextSource available since 1.18, will become compulsory in 1.18.
193 * Obviates the need to call $form->setTitle()
194 * @param $messagePrefix String a prefix to go in front of default messages
196 public function __construct( $descriptor, /*IContextSource*/ $context = null, $messagePrefix = '' ) {
197 if ( $context instanceof IContextSource
) {
198 $this->setContext( $context );
199 $this->mTitle
= false; // We don't need them to set a title
200 $this->mMessagePrefix
= $messagePrefix;
203 if ( is_string( $context ) && $messagePrefix === '' ) {
204 // it's actually $messagePrefix
205 $this->mMessagePrefix
= $context;
209 // Expand out into a tree.
210 $loadedDescriptor = array();
211 $this->mFlatFields
= array();
213 foreach ( $descriptor as $fieldname => $info ) {
214 $section = isset( $info['section'] )
218 if ( isset( $info['type'] ) && $info['type'] == 'file' ) {
219 $this->mUseMultipart
= true;
222 $field = self
::loadInputFromParameters( $fieldname, $info );
223 $field->mParent
= $this;
225 $setSection =& $loadedDescriptor;
227 $sectionParts = explode( '/', $section );
229 while ( count( $sectionParts ) ) {
230 $newName = array_shift( $sectionParts );
232 if ( !isset( $setSection[$newName] ) ) {
233 $setSection[$newName] = array();
236 $setSection =& $setSection[$newName];
240 $setSection[$fieldname] = $field;
241 $this->mFlatFields
[$fieldname] = $field;
244 $this->mFieldTree
= $loadedDescriptor;
248 * Set format in which to display the form
249 * @param $format String the name of the format to use, must be one of
250 * $this->availableDisplayFormats
251 * @throws MWException
253 * @return HTMLForm $this for chaining calls (since 1.20)
255 public function setDisplayFormat( $format ) {
256 if ( !in_array( $format, $this->availableDisplayFormats
) ) {
257 throw new MWException ( 'Display format must be one of ' . print_r( $this->availableDisplayFormats
, true ) );
259 $this->displayFormat
= $format;
264 * Getter for displayFormat
268 public function getDisplayFormat() {
269 return $this->displayFormat
;
273 * Add the HTMLForm-specific JavaScript, if it hasn't been
275 * @deprecated since 1.18 load modules with ResourceLoader instead
277 static function addJS() { wfDeprecated( __METHOD__
, '1.18' ); }
280 * Initialise a new Object for the field
281 * @param $fieldname string
282 * @param $descriptor string input Descriptor, as described above
283 * @throws MWException
284 * @return HTMLFormField subclass
286 static function loadInputFromParameters( $fieldname, $descriptor ) {
287 if ( isset( $descriptor['class'] ) ) {
288 $class = $descriptor['class'];
289 } elseif ( isset( $descriptor['type'] ) ) {
290 $class = self
::$typeMappings[$descriptor['type']];
291 $descriptor['class'] = $class;
297 throw new MWException( "Descriptor with no class: " . print_r( $descriptor, true ) );
300 $descriptor['fieldname'] = $fieldname;
303 # This will throw a fatal error whenever someone try to use
304 # 'class' to feed a CSS class instead of 'cssclass'. Would be
305 # great to avoid the fatal error and show a nice error.
306 $obj = new $class( $descriptor );
312 * Prepare form for submission.
314 * @attention When doing method chaining, that should be the very last
315 * method call before displayForm().
317 * @throws MWException
318 * @return HTMLForm $this for chaining calls (since 1.20)
320 function prepareForm() {
321 # Check if we have the info we need
322 if ( !$this->mTitle
instanceof Title
&& $this->mTitle
!== false ) {
323 throw new MWException( "You must call setTitle() on an HTMLForm" );
326 # Load data from the request.
332 * Try submitting, with edit token check first
333 * @return Status|boolean
335 function tryAuthorizedSubmit() {
339 if ( $this->getMethod() != 'post' ) {
340 $submit = true; // no session check needed
341 } elseif ( $this->getRequest()->wasPosted() ) {
342 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
343 if ( $this->getUser()->isLoggedIn() ||
$editToken != null ) {
344 // Session tokens for logged-out users have no security value.
345 // However, if the user gave one, check it in order to give a nice
346 // "session expired" error instead of "permission denied" or such.
347 $submit = $this->getUser()->matchEditToken( $editToken );
354 $result = $this->trySubmit();
361 * The here's-one-I-made-earlier option: do the submission if
362 * posted, or display the form with or without funky validation
364 * @return Bool or Status whether submission was successful.
367 $this->prepareForm();
369 $result = $this->tryAuthorizedSubmit();
370 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ) {
374 $this->displayForm( $result );
379 * Validate all the fields, and call the submision callback
380 * function if everything is kosher.
381 * @throws MWException
382 * @return Mixed Bool true == Successful submission, Bool false
383 * == No submission attempted, anything else == Error to
386 function trySubmit() {
387 # Check for validation
388 foreach ( $this->mFlatFields
as $fieldname => $field ) {
389 if ( !empty( $field->mParams
['nodata'] ) ) {
392 if ( $field->validate(
393 $this->mFieldData
[$fieldname],
397 return isset( $this->mValidationErrorMessage
)
398 ?
$this->mValidationErrorMessage
399 : array( 'htmlform-invalid-input' );
403 $callback = $this->mSubmitCallback
;
404 if ( !is_callable( $callback ) ) {
405 throw new MWException( 'HTMLForm: no submit callback provided. Use setSubmitCallback() to set one.' );
408 $data = $this->filterDataForSubmit( $this->mFieldData
);
410 $res = call_user_func( $callback, $data, $this );
416 * Set a callback to a function to do something with the form
417 * once it's been successfully validated.
418 * @param $cb String function name. The function will be passed
419 * the output from HTMLForm::filterDataForSubmit, and must
420 * return Bool true on success, Bool false if no submission
421 * was attempted, or String HTML output to display on error.
422 * @return HTMLForm $this for chaining calls (since 1.20)
424 function setSubmitCallback( $cb ) {
425 $this->mSubmitCallback
= $cb;
430 * Set a message to display on a validation error.
431 * @param $msg Mixed String or Array of valid inputs to wfMessage()
432 * (so each entry can be either a String or Array)
433 * @return HTMLForm $this for chaining calls (since 1.20)
435 function setValidationErrorMessage( $msg ) {
436 $this->mValidationErrorMessage
= $msg;
441 * Set the introductory message, overwriting any existing message.
442 * @param $msg String complete text of message to display
443 * @return HTMLForm $this for chaining calls (since 1.20)
445 function setIntro( $msg ) {
446 $this->setPreText( $msg );
451 * Set the introductory message, overwriting any existing message.
453 * @param $msg String complete text of message to display
454 * @return HTMLForm $this for chaining calls (since 1.20)
456 function setPreText( $msg ) {
462 * Add introductory text.
463 * @param $msg String complete text of message to display
464 * @return HTMLForm $this for chaining calls (since 1.20)
466 function addPreText( $msg ) {
472 * Add header text, inside the form.
473 * @param $msg String complete text of message to display
474 * @param $section string The section to add the header to
475 * @return HTMLForm $this for chaining calls (since 1.20)
477 function addHeaderText( $msg, $section = null ) {
478 if ( is_null( $section ) ) {
479 $this->mHeader
.= $msg;
481 if ( !isset( $this->mSectionHeaders
[$section] ) ) {
482 $this->mSectionHeaders
[$section] = '';
484 $this->mSectionHeaders
[$section] .= $msg;
490 * Set header text, inside the form.
492 * @param $msg String complete text of message to display
493 * @param $section The section to add the header to
494 * @return HTMLForm $this for chaining calls (since 1.20)
496 function setHeaderText( $msg, $section = null ) {
497 if ( is_null( $section ) ) {
498 $this->mHeader
= $msg;
500 $this->mSectionHeaders
[$section] = $msg;
506 * Add footer text, inside the form.
507 * @param $msg String complete text of message to display
508 * @param $section string The section to add the footer text to
509 * @return HTMLForm $this for chaining calls (since 1.20)
511 function addFooterText( $msg, $section = null ) {
512 if ( is_null( $section ) ) {
513 $this->mFooter
.= $msg;
515 if ( !isset( $this->mSectionFooters
[$section] ) ) {
516 $this->mSectionFooters
[$section] = '';
518 $this->mSectionFooters
[$section] .= $msg;
524 * Set footer text, inside the form.
526 * @param $msg String complete text of message to display
527 * @param $section string The section to add the footer text to
528 * @return HTMLForm $this for chaining calls (since 1.20)
530 function setFooterText( $msg, $section = null ) {
531 if ( is_null( $section ) ) {
532 $this->mFooter
= $msg;
534 $this->mSectionFooters
[$section] = $msg;
540 * Add text to the end of the display.
541 * @param $msg String complete text of message to display
542 * @return HTMLForm $this for chaining calls (since 1.20)
544 function addPostText( $msg ) {
545 $this->mPost
.= $msg;
550 * Set text at the end of the display.
551 * @param $msg String complete text of message to display
552 * @return HTMLForm $this for chaining calls (since 1.20)
554 function setPostText( $msg ) {
560 * Add a hidden field to the output
561 * @param $name String field name. This will be used exactly as entered
562 * @param $value String field value
563 * @param $attribs Array
564 * @return HTMLForm $this for chaining calls (since 1.20)
566 public function addHiddenField( $name, $value, $attribs = array() ) {
567 $attribs +
= array( 'name' => $name );
568 $this->mHiddenFields
[] = array( $value, $attribs );
573 * Add a button to the form
574 * @param $name String field name.
575 * @param $value String field value
576 * @param $id String DOM id for the button (default: null)
577 * @param $attribs Array
578 * @return HTMLForm $this for chaining calls (since 1.20)
580 public function addButton( $name, $value, $id = null, $attribs = null ) {
581 $this->mButtons
[] = compact( 'name', 'value', 'id', 'attribs' );
586 * Display the form (sending to $wgOut), with an appropriate error
587 * message or stack of messages, and any validation errors, etc.
589 * @attention You should call prepareForm() before calling this function.
590 * Moreover, when doing method chaining this should be the very last method
591 * call just after prepareForm().
593 * @param $submitResult Mixed output from HTMLForm::trySubmit()
594 * @return Nothing, should be last call
596 function displayForm( $submitResult ) {
597 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
601 * Returns the raw HTML generated by the form
602 * @param $submitResult Mixed output from HTMLForm::trySubmit()
605 function getHTML( $submitResult ) {
606 # For good measure (it is the default)
607 $this->getOutput()->preventClickjacking();
608 $this->getOutput()->addModules( 'mediawiki.htmlform' );
611 . $this->getErrors( $submitResult )
614 . $this->getHiddenFields()
615 . $this->getButtons()
619 $html = $this->wrapForm( $html );
621 return '' . $this->mPre
. $html . $this->mPost
;
625 * Wrap the form innards in an actual "<form>" element
626 * @param $html String HTML contents to wrap.
627 * @return String wrapped HTML.
629 function wrapForm( $html ) {
631 # Include a <fieldset> wrapper for style, if requested.
632 if ( $this->mWrapperLegend
!== false ) {
633 $html = Xml
::fieldset( $this->mWrapperLegend
, $html );
635 # Use multipart/form-data
636 $encType = $this->mUseMultipart
637 ?
'multipart/form-data'
638 : 'application/x-www-form-urlencoded';
641 'action' => $this->mAction
=== false ?
$this->getTitle()->getFullURL() : $this->mAction
,
642 'method' => $this->mMethod
,
643 'class' => 'visualClear',
644 'enctype' => $encType,
646 if ( !empty( $this->mId
) ) {
647 $attribs['id'] = $this->mId
;
650 return Html
::rawElement( 'form', $attribs, $html );
654 * Get the hidden fields that should go inside the form.
655 * @return String HTML.
657 function getHiddenFields() {
658 global $wgArticlePath;
661 if ( $this->getMethod() == 'post' ) {
662 $html .= Html
::hidden( 'wpEditToken', $this->getUser()->getEditToken(), array( 'id' => 'wpEditToken' ) ) . "\n";
663 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
666 if ( strpos( $wgArticlePath, '?' ) !== false && $this->getMethod() == 'get' ) {
667 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
670 foreach ( $this->mHiddenFields
as $data ) {
671 list( $value, $attribs ) = $data;
672 $html .= Html
::hidden( $attribs['name'], $value, $attribs ) . "\n";
679 * Get the submit and (potentially) reset buttons.
680 * @return String HTML.
682 function getButtons() {
686 if ( isset( $this->mSubmitID
) ) {
687 $attribs['id'] = $this->mSubmitID
;
690 if ( isset( $this->mSubmitName
) ) {
691 $attribs['name'] = $this->mSubmitName
;
694 if ( isset( $this->mSubmitTooltip
) ) {
695 $attribs +
= Linker
::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip
);
698 $attribs['class'] = 'mw-htmlform-submit';
700 $html .= Xml
::submitButton( $this->getSubmitText(), $attribs ) . "\n";
702 if ( $this->mShowReset
) {
703 $html .= Html
::element(
707 'value' => $this->msg( 'htmlform-reset' )->text()
712 foreach ( $this->mButtons
as $button ) {
715 'name' => $button['name'],
716 'value' => $button['value']
719 if ( $button['attribs'] ) {
720 $attrs +
= $button['attribs'];
723 if ( isset( $button['id'] ) ) {
724 $attrs['id'] = $button['id'];
727 $html .= Html
::element( 'input', $attrs );
734 * Get the whole body of the form.
738 return $this->displaySection( $this->mFieldTree
);
742 * Format and display an error message stack.
743 * @param $errors String|Array|Status
746 function getErrors( $errors ) {
747 if ( $errors instanceof Status
) {
748 if ( $errors->isOK() ) {
751 $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
753 } elseif ( is_array( $errors ) ) {
754 $errorstr = $this->formatErrors( $errors );
760 ? Html
::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
765 * Format a stack of error messages into a single HTML string
766 * @param $errors Array of message keys/values
767 * @return String HTML, a "<ul>" list of errors
769 public static function formatErrors( $errors ) {
772 foreach ( $errors as $error ) {
773 if ( is_array( $error ) ) {
774 $msg = array_shift( $error );
780 $errorstr .= Html
::rawElement(
783 wfMessage( $msg, $error )->parse()
787 $errorstr = Html
::rawElement( 'ul', array(), $errorstr );
793 * Set the text for the submit button
794 * @param $t String plaintext.
795 * @return HTMLForm $this for chaining calls (since 1.20)
797 function setSubmitText( $t ) {
798 $this->mSubmitText
= $t;
803 * Set the text for the submit button to a message
805 * @param $msg String message key
806 * @return HTMLForm $this for chaining calls (since 1.20)
808 public function setSubmitTextMsg( $msg ) {
809 $this->setSubmitText( $this->msg( $msg )->text() );
814 * Get the text for the submit button, either customised or a default.
817 function getSubmitText() {
818 return $this->mSubmitText
820 : $this->msg( 'htmlform-submit' )->text();
824 * @param $name String Submit button name
825 * @return HTMLForm $this for chaining calls (since 1.20)
827 public function setSubmitName( $name ) {
828 $this->mSubmitName
= $name;
833 * @param $name String Tooltip for the submit button
834 * @return HTMLForm $this for chaining calls (since 1.20)
836 public function setSubmitTooltip( $name ) {
837 $this->mSubmitTooltip
= $name;
842 * Set the id for the submit button.
844 * @todo FIXME: Integrity of $t is *not* validated
845 * @return HTMLForm $this for chaining calls (since 1.20)
847 function setSubmitID( $t ) {
848 $this->mSubmitID
= $t;
853 * @param $id String DOM id for the form
854 * @return HTMLForm $this for chaining calls (since 1.20)
856 public function setId( $id ) {
861 * Prompt the whole form to be wrapped in a "<fieldset>", with
862 * this text as its "<legend>" element.
863 * @param $legend String HTML to go inside the "<legend>" element.
865 * @return HTMLForm $this for chaining calls (since 1.20)
867 public function setWrapperLegend( $legend ) {
868 $this->mWrapperLegend
= $legend;
873 * Prompt the whole form to be wrapped in a "<fieldset>", with
874 * this message as its "<legend>" element.
876 * @param $msg String message key
877 * @return HTMLForm $this for chaining calls (since 1.20)
879 public function setWrapperLegendMsg( $msg ) {
880 $this->setWrapperLegend( $this->msg( $msg )->text() );
885 * Set the prefix for various default messages
886 * @todo currently only used for the "<fieldset>" legend on forms
887 * with multiple sections; should be used elsewhre?
889 * @return HTMLForm $this for chaining calls (since 1.20)
891 function setMessagePrefix( $p ) {
892 $this->mMessagePrefix
= $p;
897 * Set the title for form submission
898 * @param $t Title of page the form is on/should be posted to
899 * @return HTMLForm $this for chaining calls (since 1.20)
901 function setTitle( $t ) {
910 function getTitle() {
911 return $this->mTitle
=== false
912 ?
$this->getContext()->getTitle()
917 * Set the method used to submit the form
918 * @param $method String
919 * @return HTMLForm $this for chaining calls (since 1.20)
921 public function setMethod( $method = 'post' ) {
922 $this->mMethod
= $method;
926 public function getMethod() {
927 return $this->mMethod
;
932 * @param $fields array[]|HTMLFormField[] array of fields (either arrays or objects)
933 * @param $sectionName string ID attribute of the "<table>" tag for this section, ignored if empty
934 * @param $fieldsetIDPrefix string ID prefix for the "<fieldset>" tag of each subsection, ignored if empty
937 public function displaySection( $fields, $sectionName = '', $fieldsetIDPrefix = '' ) {
938 $displayFormat = $this->getDisplayFormat();
941 $subsectionHtml = '';
944 $getFieldHtmlMethod = ( $displayFormat == 'table' ) ?
'getTableRow' : 'get' . ucfirst( $displayFormat );
946 foreach ( $fields as $key => $value ) {
947 if ( $value instanceof HTMLFormField
) {
948 $v = empty( $value->mParams
['nodata'] )
949 ?
$this->mFieldData
[$key]
950 : $value->getDefault();
951 $html .= $value->$getFieldHtmlMethod( $v );
953 $labelValue = trim( $value->getLabel() );
954 if ( $labelValue != ' ' && $labelValue !== '' ) {
957 } elseif ( is_array( $value ) ) {
958 $section = $this->displaySection( $value, $key );
959 $legend = $this->getLegend( $key );
960 if ( isset( $this->mSectionHeaders
[$key] ) ) {
961 $section = $this->mSectionHeaders
[$key] . $section;
963 if ( isset( $this->mSectionFooters
[$key] ) ) {
964 $section .= $this->mSectionFooters
[$key];
966 $attributes = array();
967 if ( $fieldsetIDPrefix ) {
968 $attributes['id'] = Sanitizer
::escapeId( "$fieldsetIDPrefix$key" );
970 $subsectionHtml .= Xml
::fieldset( $legend, $section, $attributes ) . "\n";
974 if ( $displayFormat !== 'raw' ) {
977 if ( !$hasLabel ) { // Avoid strange spacing when no labels exist
978 $classes[] = 'mw-htmlform-nolabel';
982 'class' => implode( ' ', $classes ),
985 if ( $sectionName ) {
986 $attribs['id'] = Sanitizer
::escapeId( "mw-htmlform-$sectionName" );
989 if ( $displayFormat === 'table' ) {
990 $html = Html
::rawElement( 'table', $attribs,
991 Html
::rawElement( 'tbody', array(), "\n$html\n" ) ) . "\n";
992 } elseif ( $displayFormat === 'div' ) {
993 $html = Html
::rawElement( 'div', $attribs, "\n$html\n" );
997 if ( $this->mSubSectionBeforeFields
) {
998 return $subsectionHtml . "\n" . $html;
1000 return $html . "\n" . $subsectionHtml;
1005 * Construct the form fields from the Descriptor array
1007 function loadData() {
1008 $fieldData = array();
1010 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1011 if ( !empty( $field->mParams
['nodata'] ) ) {
1013 } elseif ( !empty( $field->mParams
['disabled'] ) ) {
1014 $fieldData[$fieldname] = $field->getDefault();
1016 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
1021 foreach ( $fieldData as $name => &$value ) {
1022 $field = $this->mFlatFields
[$name];
1023 $value = $field->filter( $value, $this->mFlatFields
);
1026 $this->mFieldData
= $fieldData;
1030 * Stop a reset button being shown for this form
1031 * @param $suppressReset Bool set to false to re-enable the
1033 * @return HTMLForm $this for chaining calls (since 1.20)
1035 function suppressReset( $suppressReset = true ) {
1036 $this->mShowReset
= !$suppressReset;
1041 * Overload this if you want to apply special filtration routines
1042 * to the form as a whole, after it's submitted but before it's
1047 function filterDataForSubmit( $data ) {
1052 * Get a string to go in the "<legend>" of a section fieldset.
1053 * Override this if you want something more complicated.
1054 * @param $key String
1057 public function getLegend( $key ) {
1058 return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1062 * Set the value for the action attribute of the form.
1063 * When set to false (which is the default state), the set title is used.
1067 * @param string|bool $action
1068 * @return HTMLForm $this for chaining calls (since 1.20)
1070 public function setAction( $action ) {
1071 $this->mAction
= $action;
1078 * The parent class to generate form fields. Any field type should
1079 * be a subclass of this.
1081 abstract class HTMLFormField
{
1083 protected $mValidationCallback;
1084 protected $mFilterCallback;
1087 protected $mLabel; # String label. Set on construction
1089 protected $mClass = '';
1090 protected $mDefault;
1098 * This function must be implemented to return the HTML to generate
1099 * the input object itself. It should not implement the surrounding
1100 * table cells/rows, or labels/help messages.
1101 * @param $value String the value to set the input to; eg a default
1102 * text for a text input.
1103 * @return String valid HTML.
1105 abstract function getInputHTML( $value );
1108 * Get a translated interface message
1110 * This is a wrapper arround $this->mParent->msg() if $this->mParent is set
1111 * and wfMessage() otherwise.
1113 * Parameters are the same as wfMessage().
1115 * @return Message object
1118 $args = func_get_args();
1120 if ( $this->mParent
) {
1121 $callback = array( $this->mParent
, 'msg' );
1123 $callback = 'wfMessage';
1126 return call_user_func_array( $callback, $args );
1130 * Override this function to add specific validation checks on the
1131 * field input. Don't forget to call parent::validate() to ensure
1132 * that the user-defined callback mValidationCallback is still run
1133 * @param $value String the value the field was submitted with
1134 * @param $alldata Array the data collected from the form
1135 * @return Mixed Bool true on success, or String error to display.
1137 function validate( $value, $alldata ) {
1138 if ( isset( $this->mParams
['required'] ) && $this->mParams
['required'] !== false && $value === '' ) {
1139 return $this->msg( 'htmlform-required' )->parse();
1142 if ( isset( $this->mValidationCallback
) ) {
1143 return call_user_func( $this->mValidationCallback
, $value, $alldata, $this->mParent
);
1149 function filter( $value, $alldata ) {
1150 if ( isset( $this->mFilterCallback
) ) {
1151 $value = call_user_func( $this->mFilterCallback
, $value, $alldata, $this->mParent
);
1158 * Should this field have a label, or is there no input element with the
1159 * appropriate id for the label to point to?
1161 * @return bool True to output a label, false to suppress
1163 protected function needsLabel() {
1168 * Get the value that this input has been set to from a posted form,
1169 * or the input's default value if it has not been set.
1170 * @param $request WebRequest
1171 * @return String the value
1173 function loadDataFromRequest( $request ) {
1174 if ( $request->getCheck( $this->mName
) ) {
1175 return $request->getText( $this->mName
);
1177 return $this->getDefault();
1182 * Initialise the object
1183 * @param $params array Associative Array. See HTMLForm doc for syntax.
1184 * @throws MWException
1186 function __construct( $params ) {
1187 $this->mParams
= $params;
1189 # Generate the label from a message, if possible
1190 if ( isset( $params['label-message'] ) ) {
1191 $msgInfo = $params['label-message'];
1193 if ( is_array( $msgInfo ) ) {
1194 $msg = array_shift( $msgInfo );
1200 $this->mLabel
= wfMessage( $msg, $msgInfo )->parse();
1201 } elseif ( isset( $params['label'] ) ) {
1202 $this->mLabel
= $params['label'];
1205 $this->mName
= "wp{$params['fieldname']}";
1206 if ( isset( $params['name'] ) ) {
1207 $this->mName
= $params['name'];
1210 $validName = Sanitizer
::escapeId( $this->mName
);
1211 if ( $this->mName
!= $validName && !isset( $params['nodata'] ) ) {
1212 throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__
);
1215 $this->mID
= "mw-input-{$this->mName}";
1217 if ( isset( $params['default'] ) ) {
1218 $this->mDefault
= $params['default'];
1221 if ( isset( $params['id'] ) ) {
1222 $id = $params['id'];
1223 $validId = Sanitizer
::escapeId( $id );
1225 if ( $id != $validId ) {
1226 throw new MWException( "Invalid id '$id' passed to " . __METHOD__
);
1232 if ( isset( $params['cssclass'] ) ) {
1233 $this->mClass
= $params['cssclass'];
1236 if ( isset( $params['validation-callback'] ) ) {
1237 $this->mValidationCallback
= $params['validation-callback'];
1240 if ( isset( $params['filter-callback'] ) ) {
1241 $this->mFilterCallback
= $params['filter-callback'];
1244 if ( isset( $params['flatlist'] ) ) {
1245 $this->mClass
.= ' mw-htmlform-flatlist';
1250 * Get the complete table row for the input, including help text,
1251 * labels, and whatever.
1252 * @param $value String the value to set the input to.
1253 * @return String complete HTML table row.
1255 function getTableRow( $value ) {
1256 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
1257 $inputHtml = $this->getInputHTML( $value );
1258 $fieldType = get_class( $this );
1259 $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
1260 $cellAttributes = array();
1262 if ( !empty( $this->mParams
['vertical-label'] ) ) {
1263 $cellAttributes['colspan'] = 2;
1264 $verticalLabel = true;
1266 $verticalLabel = false;
1269 $label = $this->getLabelHtml( $cellAttributes );
1271 $field = Html
::rawElement(
1273 array( 'class' => 'mw-input' ) +
$cellAttributes,
1274 $inputHtml . "\n$errors"
1277 if ( $verticalLabel ) {
1278 $html = Html
::rawElement( 'tr',
1279 array( 'class' => 'mw-htmlform-vertical-label' ), $label );
1280 $html .= Html
::rawElement( 'tr',
1281 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
1284 $html = Html
::rawElement( 'tr',
1285 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
1289 return $html . $helptext;
1293 * Get the complete div for the input, including help text,
1294 * labels, and whatever.
1296 * @param $value String the value to set the input to.
1297 * @return String complete HTML table row.
1299 public function getDiv( $value ) {
1300 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
1301 $inputHtml = $this->getInputHTML( $value );
1302 $fieldType = get_class( $this );
1303 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
1304 $cellAttributes = array();
1305 $label = $this->getLabelHtml( $cellAttributes );
1307 $field = Html
::rawElement(
1309 array( 'class' => 'mw-input' ) +
$cellAttributes,
1310 $inputHtml . "\n$errors"
1312 $html = Html
::rawElement( 'div',
1313 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
1320 * Get the complete raw fields for the input, including help text,
1321 * labels, and whatever.
1323 * @param $value String the value to set the input to.
1324 * @return String complete HTML table row.
1326 public function getRaw( $value ) {
1327 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
1328 $inputHtml = $this->getInputHTML( $value );
1329 $helptext = $this->getHelpTextHtmlRaw( $this->getHelpText() );
1330 $cellAttributes = array();
1331 $label = $this->getLabelHtml( $cellAttributes );
1333 $html = "\n$errors";
1335 $html .= $inputHtml;
1341 * Generate help text HTML in table format
1343 * @param $helptext String|null
1346 public function getHelpTextHtmlTable( $helptext ) {
1347 if ( is_null( $helptext ) ) {
1351 $row = Html
::rawElement(
1353 array( 'colspan' => 2, 'class' => 'htmlform-tip' ),
1356 $row = Html
::rawElement( 'tr', array(), $row );
1361 * Generate help text HTML in div format
1363 * @param $helptext String|null
1366 public function getHelpTextHtmlDiv( $helptext ) {
1367 if ( is_null( $helptext ) ) {
1371 $div = Html
::rawElement( 'div', array( 'class' => 'htmlform-tip' ), $helptext );
1376 * Generate help text HTML formatted for raw output
1378 * @param $helptext String|null
1381 public function getHelpTextHtmlRaw( $helptext ) {
1382 return $this->getHelpTextHtmlDiv( $helptext );
1386 * Determine the help text to display
1390 public function getHelpText() {
1393 if ( isset( $this->mParams
['help-message'] ) ) {
1394 $this->mParams
['help-messages'] = array( $this->mParams
['help-message'] );
1397 if ( isset( $this->mParams
['help-messages'] ) ) {
1398 foreach ( $this->mParams
['help-messages'] as $name ) {
1399 $helpMessage = (array)$name;
1400 $msg = $this->msg( array_shift( $helpMessage ), $helpMessage );
1402 if ( $msg->exists() ) {
1403 if ( is_null( $helptext ) ) {
1406 $helptext .= $this->msg( 'word-separator' )->escaped(); // some space
1408 $helptext .= $msg->parse(); // Append message
1412 elseif ( isset( $this->mParams
['help'] ) ) {
1413 $helptext = $this->mParams
['help'];
1419 * Determine form errors to display and their classes
1421 * @param $value String the value of the input
1424 public function getErrorsAndErrorClass( $value ) {
1425 $errors = $this->validate( $value, $this->mParent
->mFieldData
);
1427 if ( $errors === true ||
( !$this->mParent
->getRequest()->wasPosted() && ( $this->mParent
->getMethod() == 'post' ) ) ) {
1431 $errors = self
::formatErrors( $errors );
1432 $errorClass = 'mw-htmlform-invalid-input';
1434 return array( $errors, $errorClass );
1437 function getLabel() {
1438 return $this->mLabel
;
1441 function getLabelHtml( $cellAttributes = array() ) {
1442 # Don't output a for= attribute for labels with no associated input.
1443 # Kind of hacky here, possibly we don't want these to be <label>s at all.
1446 if ( $this->needsLabel() ) {
1447 $for['for'] = $this->mID
;
1450 $displayFormat = $this->mParent
->getDisplayFormat();
1451 $labelElement = Html
::rawElement( 'label', $for, $this->getLabel() );
1453 if ( $displayFormat == 'table' ) {
1454 return Html
::rawElement( 'td', array( 'class' => 'mw-label' ) +
$cellAttributes,
1455 Html
::rawElement( 'label', $for, $this->getLabel() )
1457 } elseif ( $displayFormat == 'div' ) {
1458 return Html
::rawElement( 'div', array( 'class' => 'mw-label' ) +
$cellAttributes,
1459 Html
::rawElement( 'label', $for, $this->getLabel() )
1462 return $labelElement;
1466 function getDefault() {
1467 if ( isset( $this->mDefault
) ) {
1468 return $this->mDefault
;
1475 * Returns the attributes required for the tooltip and accesskey.
1477 * @return array Attributes
1479 public function getTooltipAndAccessKey() {
1480 if ( empty( $this->mParams
['tooltip'] ) ) {
1483 return Linker
::tooltipAndAccesskeyAttribs( $this->mParams
['tooltip'] );
1487 * flatten an array of options to a single array, for instance,
1488 * a set of "<options>" inside "<optgroups>".
1489 * @param $options array Associative Array with values either Strings
1491 * @return Array flattened input
1493 public static function flattenOptions( $options ) {
1494 $flatOpts = array();
1496 foreach ( $options as $value ) {
1497 if ( is_array( $value ) ) {
1498 $flatOpts = array_merge( $flatOpts, self
::flattenOptions( $value ) );
1500 $flatOpts[] = $value;
1508 * Formats one or more errors as accepted by field validation-callback.
1509 * @param $errors String|Message|Array of strings or Message instances
1510 * @return String html
1513 protected static function formatErrors( $errors ) {
1514 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1515 $errors = array_shift( $errors );
1518 if ( is_array( $errors ) ) {
1520 foreach ( $errors as $error ) {
1521 if ( $error instanceof Message
) {
1522 $lines[] = Html
::rawElement( 'li', array(), $error->parse() );
1524 $lines[] = Html
::rawElement( 'li', array(), $error );
1527 return Html
::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
1529 if ( $errors instanceof Message
) {
1530 $errors = $errors->parse();
1532 return Html
::rawElement( 'span', array( 'class' => 'error' ), $errors );
1537 class HTMLTextField
extends HTMLFormField
{
1538 function getSize() {
1539 return isset( $this->mParams
['size'] )
1540 ?
$this->mParams
['size']
1544 function getInputHTML( $value ) {
1547 'name' => $this->mName
,
1548 'size' => $this->getSize(),
1550 ) +
$this->getTooltipAndAccessKey();
1552 if ( $this->mClass
!== '' ) {
1553 $attribs['class'] = $this->mClass
;
1556 if ( !empty( $this->mParams
['disabled'] ) ) {
1557 $attribs['disabled'] = 'disabled';
1560 # TODO: Enforce pattern, step, required, readonly on the server side as
1562 $allowedParams = array( 'min', 'max', 'pattern', 'title', 'step',
1563 'placeholder', 'list', 'maxlength' );
1564 foreach ( $allowedParams as $param ) {
1565 if ( isset( $this->mParams
[$param] ) ) {
1566 $attribs[$param] = $this->mParams
[$param];
1570 foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' ) as $param ) {
1571 if ( isset( $this->mParams
[$param] ) ) {
1572 $attribs[$param] = '';
1576 # Implement tiny differences between some field variants
1577 # here, rather than creating a new class for each one which
1578 # is essentially just a clone of this one.
1579 if ( isset( $this->mParams
['type'] ) ) {
1580 switch ( $this->mParams
['type'] ) {
1582 $attribs['type'] = 'email';
1585 $attribs['type'] = 'number';
1588 $attribs['type'] = 'number';
1589 $attribs['step'] = 'any';
1594 $attribs['type'] = $this->mParams
['type'];
1599 return Html
::element( 'input', $attribs );
1602 class HTMLTextAreaField
extends HTMLFormField
{
1603 function getCols() {
1604 return isset( $this->mParams
['cols'] )
1605 ?
$this->mParams
['cols']
1609 function getRows() {
1610 return isset( $this->mParams
['rows'] )
1611 ?
$this->mParams
['rows']
1615 function getInputHTML( $value ) {
1618 'name' => $this->mName
,
1619 'cols' => $this->getCols(),
1620 'rows' => $this->getRows(),
1621 ) +
$this->getTooltipAndAccessKey();
1623 if ( $this->mClass
!== '' ) {
1624 $attribs['class'] = $this->mClass
;
1627 if ( !empty( $this->mParams
['disabled'] ) ) {
1628 $attribs['disabled'] = 'disabled';
1631 if ( !empty( $this->mParams
['readonly'] ) ) {
1632 $attribs['readonly'] = 'readonly';
1635 if ( isset( $this->mParams
['placeholder'] ) ) {
1636 $attribs['placeholder'] = $this->mParams
['placeholder'];
1639 foreach ( array( 'required', 'autofocus' ) as $param ) {
1640 if ( isset( $this->mParams
[$param] ) ) {
1641 $attribs[$param] = '';
1645 return Html
::element( 'textarea', $attribs, $value );
1650 * A field that will contain a numeric value
1652 class HTMLFloatField
extends HTMLTextField
{
1653 function getSize() {
1654 return isset( $this->mParams
['size'] )
1655 ?
$this->mParams
['size']
1659 function validate( $value, $alldata ) {
1660 $p = parent
::validate( $value, $alldata );
1662 if ( $p !== true ) {
1666 $value = trim( $value );
1668 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#real-numbers
1669 # with the addition that a leading '+' sign is ok.
1670 if ( !preg_match( '/^((\+|\-)?\d+(\.\d+)?(E(\+|\-)?\d+)?)?$/i', $value ) ) {
1671 return $this->msg( 'htmlform-float-invalid' )->parseAsBlock();
1674 # The "int" part of these message names is rather confusing.
1675 # They make equal sense for all numbers.
1676 if ( isset( $this->mParams
['min'] ) ) {
1677 $min = $this->mParams
['min'];
1679 if ( $min > $value ) {
1680 return $this->msg( 'htmlform-int-toolow', $min )->parseAsBlock();
1684 if ( isset( $this->mParams
['max'] ) ) {
1685 $max = $this->mParams
['max'];
1687 if ( $max < $value ) {
1688 return $this->msg( 'htmlform-int-toohigh', $max )->parseAsBlock();
1697 * A field that must contain a number
1699 class HTMLIntField
extends HTMLFloatField
{
1700 function validate( $value, $alldata ) {
1701 $p = parent
::validate( $value, $alldata );
1703 if ( $p !== true ) {
1707 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#signed-integers
1708 # with the addition that a leading '+' sign is ok. Note that leading zeros
1709 # are fine, and will be left in the input, which is useful for things like
1710 # phone numbers when you know that they are integers (the HTML5 type=tel
1711 # input does not require its value to be numeric). If you want a tidier
1712 # value to, eg, save in the DB, clean it up with intval().
1713 if ( !preg_match( '/^((\+|\-)?\d+)?$/', trim( $value ) )
1715 return $this->msg( 'htmlform-int-invalid' )->parseAsBlock();
1725 class HTMLCheckField
extends HTMLFormField
{
1726 function getInputHTML( $value ) {
1727 if ( !empty( $this->mParams
['invert'] ) ) {
1731 $attr = $this->getTooltipAndAccessKey();
1732 $attr['id'] = $this->mID
;
1734 if ( !empty( $this->mParams
['disabled'] ) ) {
1735 $attr['disabled'] = 'disabled';
1738 if ( $this->mClass
!== '' ) {
1739 $attr['class'] = $this->mClass
;
1742 return Xml
::check( $this->mName
, $value, $attr ) . ' ' .
1743 Html
::rawElement( 'label', array( 'for' => $this->mID
), $this->mLabel
);
1747 * For a checkbox, the label goes on the right hand side, and is
1748 * added in getInputHTML(), rather than HTMLFormField::getRow()
1751 function getLabel() {
1756 * @param $request WebRequest
1759 function loadDataFromRequest( $request ) {
1761 if ( isset( $this->mParams
['invert'] ) && $this->mParams
['invert'] ) {
1765 // GetCheck won't work like we want for checks.
1766 // Fetch the value in either one of the two following case:
1767 // - we have a valid token (form got posted or GET forged by the user)
1768 // - checkbox name has a value (false or true), ie is not null
1769 if ( $request->getCheck( 'wpEditToken' ) ||
$request->getVal( $this->mName
) !== null ) {
1770 // XOR has the following truth table, which is what we want
1771 // INVERT VALUE | OUTPUT
1772 // true true | false
1773 // false true | true
1774 // false false | false
1775 // true false | true
1776 return $request->getBool( $this->mName
) xor $invert;
1778 return $this->getDefault();
1784 * A select dropdown field. Basically a wrapper for Xmlselect class
1786 class HTMLSelectField
extends HTMLFormField
{
1787 function validate( $value, $alldata ) {
1788 $p = parent
::validate( $value, $alldata );
1790 if ( $p !== true ) {
1794 $validOptions = HTMLFormField
::flattenOptions( $this->mParams
['options'] );
1796 if ( in_array( $value, $validOptions ) )
1799 return $this->msg( 'htmlform-select-badoption' )->parse();
1802 function getInputHTML( $value ) {
1803 $select = new XmlSelect( $this->mName
, $this->mID
, strval( $value ) );
1805 # If one of the options' 'name' is int(0), it is automatically selected.
1806 # because PHP sucks and thinks int(0) == 'some string'.
1807 # Working around this by forcing all of them to strings.
1808 foreach ( $this->mParams
['options'] as &$opt ) {
1809 if ( is_int( $opt ) ) {
1810 $opt = strval( $opt );
1813 unset( $opt ); # PHP keeps $opt around as a reference, which is a bit scary
1815 if ( !empty( $this->mParams
['disabled'] ) ) {
1816 $select->setAttribute( 'disabled', 'disabled' );
1819 if ( $this->mClass
!== '' ) {
1820 $select->setAttribute( 'class', $this->mClass
);
1823 $select->addOptions( $this->mParams
['options'] );
1825 return $select->getHTML();
1830 * Select dropdown field, with an additional "other" textbox.
1832 class HTMLSelectOrOtherField
extends HTMLTextField
{
1833 static $jsAdded = false;
1835 function __construct( $params ) {
1836 if ( !in_array( 'other', $params['options'], true ) ) {
1837 $msg = isset( $params['other'] ) ?
1839 wfMessage( 'htmlform-selectorother-other' )->text();
1840 $params['options'][$msg] = 'other';
1843 parent
::__construct( $params );
1846 static function forceToStringRecursive( $array ) {
1847 if ( is_array( $array ) ) {
1848 return array_map( array( __CLASS__
, 'forceToStringRecursive' ), $array );
1850 return strval( $array );
1854 function getInputHTML( $value ) {
1855 $valInSelect = false;
1857 if ( $value !== false ) {
1858 $valInSelect = in_array(
1860 HTMLFormField
::flattenOptions( $this->mParams
['options'] )
1864 $selected = $valInSelect ?
$value : 'other';
1866 $opts = self
::forceToStringRecursive( $this->mParams
['options'] );
1868 $select = new XmlSelect( $this->mName
, $this->mID
, $selected );
1869 $select->addOptions( $opts );
1871 $select->setAttribute( 'class', 'mw-htmlform-select-or-other' );
1873 $tbAttribs = array( 'id' => $this->mID
. '-other', 'size' => $this->getSize() );
1875 if ( !empty( $this->mParams
['disabled'] ) ) {
1876 $select->setAttribute( 'disabled', 'disabled' );
1877 $tbAttribs['disabled'] = 'disabled';
1880 $select = $select->getHTML();
1882 if ( isset( $this->mParams
['maxlength'] ) ) {
1883 $tbAttribs['maxlength'] = $this->mParams
['maxlength'];
1886 if ( $this->mClass
!== '' ) {
1887 $tbAttribs['class'] = $this->mClass
;
1890 $textbox = Html
::input(
1891 $this->mName
. '-other',
1892 $valInSelect ?
'' : $value,
1897 return "$select<br />\n$textbox";
1901 * @param $request WebRequest
1904 function loadDataFromRequest( $request ) {
1905 if ( $request->getCheck( $this->mName
) ) {
1906 $val = $request->getText( $this->mName
);
1908 if ( $val == 'other' ) {
1909 $val = $request->getText( $this->mName
. '-other' );
1914 return $this->getDefault();
1920 * Multi-select field
1922 class HTMLMultiSelectField
extends HTMLFormField
{
1924 function validate( $value, $alldata ) {
1925 $p = parent
::validate( $value, $alldata );
1927 if ( $p !== true ) {
1931 if ( !is_array( $value ) ) {
1935 # If all options are valid, array_intersect of the valid options
1936 # and the provided options will return the provided options.
1937 $validOptions = HTMLFormField
::flattenOptions( $this->mParams
['options'] );
1939 $validValues = array_intersect( $value, $validOptions );
1940 if ( count( $validValues ) == count( $value ) ) {
1943 return $this->msg( 'htmlform-select-badoption' )->parse();
1947 function getInputHTML( $value ) {
1948 $html = $this->formatOptions( $this->mParams
['options'], $value );
1953 function formatOptions( $options, $value ) {
1958 if ( !empty( $this->mParams
['disabled'] ) ) {
1959 $attribs['disabled'] = 'disabled';
1962 foreach ( $options as $label => $info ) {
1963 if ( is_array( $info ) ) {
1964 $html .= Html
::rawElement( 'h1', array(), $label ) . "\n";
1965 $html .= $this->formatOptions( $info, $value );
1967 $thisAttribs = array( 'id' => "{$this->mID}-$info", 'value' => $info );
1969 $checkbox = Xml
::check(
1970 $this->mName
. '[]',
1971 in_array( $info, $value, true ),
1972 $attribs +
$thisAttribs );
1973 $checkbox .= ' ' . Html
::rawElement( 'label', array( 'for' => "{$this->mID}-$info" ), $label );
1975 $html .= ' ' . Html
::rawElement( 'div', array( 'class' => 'mw-htmlform-flatlist-item' ), $checkbox );
1983 * @param $request WebRequest
1986 function loadDataFromRequest( $request ) {
1987 if ( $this->mParent
->getMethod() == 'post' ) {
1988 if ( $request->wasPosted() ) {
1989 # Checkboxes are just not added to the request arrays if they're not checked,
1990 # so it's perfectly possible for there not to be an entry at all
1991 return $request->getArray( $this->mName
, array() );
1993 # That's ok, the user has not yet submitted the form, so show the defaults
1994 return $this->getDefault();
1997 # This is the impossible case: if we look at $_GET and see no data for our
1998 # field, is it because the user has not yet submitted the form, or that they
1999 # have submitted it with all the options unchecked? We will have to assume the
2000 # latter, which basically means that you can't specify 'positive' defaults
2003 return $request->getArray( $this->mName
, array() );
2007 function getDefault() {
2008 if ( isset( $this->mDefault
) ) {
2009 return $this->mDefault
;
2015 protected function needsLabel() {
2021 * Double field with a dropdown list constructed from a system message in the format
2024 * * New Optgroup header
2025 * Plus a text field underneath for an additional reason. The 'value' of the field is
2026 * "<select>: <extra reason>", or "<extra reason>" if nothing has been selected in the
2028 * @todo FIXME: If made 'required', only the text field should be compulsory.
2030 class HTMLSelectAndOtherField
extends HTMLSelectField
{
2032 function __construct( $params ) {
2033 if ( array_key_exists( 'other', $params ) ) {
2034 } elseif ( array_key_exists( 'other-message', $params ) ) {
2035 $params['other'] = wfMessage( $params['other-message'] )->plain();
2037 $params['other'] = null;
2040 if ( array_key_exists( 'options', $params ) ) {
2041 # Options array already specified
2042 } elseif ( array_key_exists( 'options-message', $params ) ) {
2043 # Generate options array from a system message
2044 $params['options'] = self
::parseMessage(
2045 wfMessage( $params['options-message'] )->inContentLanguage()->plain(),
2050 throw new MWException( 'HTMLSelectAndOtherField called without any options' );
2052 $this->mFlatOptions
= self
::flattenOptions( $params['options'] );
2054 parent
::__construct( $params );
2058 * Build a drop-down box from a textual list.
2059 * @param $string String message text
2060 * @param $otherName String name of "other reason" option
2062 * TODO: this is copied from Xml::listDropDown(), deprecate/avoid duplication?
2064 public static function parseMessage( $string, $otherName = null ) {
2065 if ( $otherName === null ) {
2066 $otherName = wfMessage( 'htmlform-selectorother-other' )->plain();
2070 $options = array( $otherName => 'other' );
2072 foreach ( explode( "\n", $string ) as $option ) {
2073 $value = trim( $option );
2074 if ( $value == '' ) {
2076 } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
2077 # A new group is starting...
2078 $value = trim( substr( $value, 1 ) );
2080 } elseif ( substr( $value, 0, 2 ) == '**' ) {
2082 $opt = trim( substr( $value, 2 ) );
2083 if ( $optgroup === false ) {
2084 $options[$opt] = $opt;
2086 $options[$optgroup][$opt] = $opt;
2089 # groupless reason list
2091 $options[$option] = $option;
2098 function getInputHTML( $value ) {
2099 $select = parent
::getInputHTML( $value[1] );
2101 $textAttribs = array(
2102 'id' => $this->mID
. '-other',
2103 'size' => $this->getSize(),
2106 if ( $this->mClass
!== '' ) {
2107 $textAttribs['class'] = $this->mClass
;
2110 foreach ( array( 'required', 'autofocus', 'multiple', 'disabled' ) as $param ) {
2111 if ( isset( $this->mParams
[$param] ) ) {
2112 $textAttribs[$param] = '';
2116 $textbox = Html
::input(
2117 $this->mName
. '-other',
2123 return "$select<br />\n$textbox";
2127 * @param $request WebRequest
2128 * @return Array("<overall message>","<select value>","<text field value>")
2130 function loadDataFromRequest( $request ) {
2131 if ( $request->getCheck( $this->mName
) ) {
2133 $list = $request->getText( $this->mName
);
2134 $text = $request->getText( $this->mName
. '-other' );
2136 if ( $list == 'other' ) {
2138 } elseif ( !in_array( $list, $this->mFlatOptions
) ) {
2139 # User has spoofed the select form to give an option which wasn't
2140 # in the original offer. Sulk...
2142 } elseif ( $text == '' ) {
2145 $final = $list . $this->msg( 'colon-separator' )->inContentLanguage()->text() . $text;
2149 $final = $this->getDefault();
2153 foreach ( $this->mFlatOptions
as $option ) {
2154 $match = $option . $this->msg( 'colon-separator' )->inContentLanguage()->text();
2155 if ( strpos( $text, $match ) === 0 ) {
2157 $text = substr( $text, strlen( $match ) );
2162 return array( $final, $list, $text );
2165 function getSize() {
2166 return isset( $this->mParams
['size'] )
2167 ?
$this->mParams
['size']
2171 function validate( $value, $alldata ) {
2172 # HTMLSelectField forces $value to be one of the options in the select
2173 # field, which is not useful here. But we do want the validation further up
2175 $p = parent
::validate( $value[1], $alldata );
2177 if ( $p !== true ) {
2181 if ( isset( $this->mParams
['required'] ) && $this->mParams
['required'] !== false && $value[1] === '' ) {
2182 return $this->msg( 'htmlform-required' )->parse();
2190 * Radio checkbox fields.
2192 class HTMLRadioField
extends HTMLFormField
{
2195 function validate( $value, $alldata ) {
2196 $p = parent
::validate( $value, $alldata );
2198 if ( $p !== true ) {
2202 if ( !is_string( $value ) && !is_int( $value ) ) {
2206 $validOptions = HTMLFormField
::flattenOptions( $this->mParams
['options'] );
2208 if ( in_array( $value, $validOptions ) ) {
2211 return $this->msg( 'htmlform-select-badoption' )->parse();
2216 * This returns a block of all the radio options, in one cell.
2217 * @see includes/HTMLFormField#getInputHTML()
2218 * @param $value String
2221 function getInputHTML( $value ) {
2222 $html = $this->formatOptions( $this->mParams
['options'], $value );
2227 function formatOptions( $options, $value ) {
2231 if ( !empty( $this->mParams
['disabled'] ) ) {
2232 $attribs['disabled'] = 'disabled';
2235 # TODO: should this produce an unordered list perhaps?
2236 foreach ( $options as $label => $info ) {
2237 if ( is_array( $info ) ) {
2238 $html .= Html
::rawElement( 'h1', array(), $label ) . "\n";
2239 $html .= $this->formatOptions( $info, $value );
2241 $id = Sanitizer
::escapeId( $this->mID
. "-$info" );
2242 $radio = Xml
::radio(
2246 $attribs +
array( 'id' => $id )
2248 $radio .= ' ' .
2249 Html
::rawElement( 'label', array( 'for' => $id ), $label );
2251 $html .= ' ' . Html
::rawElement( 'div', array( 'class' => 'mw-htmlform-flatlist-item' ), $radio );
2258 protected function needsLabel() {
2264 * An information field (text blob), not a proper input.
2266 class HTMLInfoField
extends HTMLFormField
{
2267 public function __construct( $info ) {
2268 $info['nodata'] = true;
2270 parent
::__construct( $info );
2273 public function getInputHTML( $value ) {
2274 return !empty( $this->mParams
['raw'] ) ?
$value : htmlspecialchars( $value );
2277 public function getTableRow( $value ) {
2278 if ( !empty( $this->mParams
['rawrow'] ) ) {
2282 return parent
::getTableRow( $value );
2288 public function getDiv( $value ) {
2289 if ( !empty( $this->mParams
['rawrow'] ) ) {
2293 return parent
::getDiv( $value );
2299 public function getRaw( $value ) {
2300 if ( !empty( $this->mParams
['rawrow'] ) ) {
2304 return parent
::getRaw( $value );
2307 protected function needsLabel() {
2312 class HTMLHiddenField
extends HTMLFormField
{
2313 public function __construct( $params ) {
2314 parent
::__construct( $params );
2316 # Per HTML5 spec, hidden fields cannot be 'required'
2317 # http://dev.w3.org/html5/spec/states-of-the-type-attribute.html#hidden-state
2318 unset( $this->mParams
['required'] );
2321 public function getTableRow( $value ) {
2324 $params['id'] = $this->mID
;
2327 $this->mParent
->addHiddenField(
2339 public function getDiv( $value ) {
2340 return $this->getTableRow( $value );
2346 public function getRaw( $value ) {
2347 return $this->getTableRow( $value );
2350 public function getInputHTML( $value ) { return ''; }
2354 * Add a submit button inline in the form (as opposed to
2355 * HTMLForm::addButton(), which will add it at the end).
2357 class HTMLSubmitField
extends HTMLFormField
{
2359 public function __construct( $info ) {
2360 $info['nodata'] = true;
2361 parent
::__construct( $info );
2364 public function getInputHTML( $value ) {
2365 return Xml
::submitButton(
2368 'class' => 'mw-htmlform-submit ' . $this->mClass
,
2369 'name' => $this->mName
,
2375 protected function needsLabel() {
2380 * Button cannot be invalid
2381 * @param $value String
2382 * @param $alldata Array
2385 public function validate( $value, $alldata ) {
2390 class HTMLEditTools
extends HTMLFormField
{
2391 public function getInputHTML( $value ) {
2395 public function getTableRow( $value ) {
2396 $msg = $this->formatMsg();
2398 return '<tr><td></td><td class="mw-input">'
2399 . '<div class="mw-editTools">'
2400 . $msg->parseAsBlock()
2401 . "</div></td></tr>\n";
2407 public function getDiv( $value ) {
2408 $msg = $this->formatMsg();
2409 return '<div class="mw-editTools">' . $msg->parseAsBlock() . '</div>';
2415 public function getRaw( $value ) {
2416 return $this->getDiv( $value );
2419 protected function formatMsg() {
2420 if ( empty( $this->mParams
['message'] ) ) {
2421 $msg = $this->msg( 'edittools' );
2423 $msg = $this->msg( $this->mParams
['message'] );
2424 if ( $msg->isDisabled() ) {
2425 $msg = $this->msg( 'edittools' );
2428 $msg->inContentLanguage();