3 * Object handling generic submission, CSRF protection, layout and
4 * other logic for UI forms. in a reusable manner.
6 * In order to generate the form, the HTMLForm object takes an array
7 * structure detailing the form fields available. Each element of the
8 * array is a basic property-list, including the type of field, the
9 * label it is to be given in the form, callbacks for validation and
10 * 'filtering', and other pertinent information.
12 * Field types are implemented as subclasses of the generic HTMLFormField
13 * object, and typically implement at least getInputHTML, which generates
14 * the HTML for the input field to be placed in the table.
16 * The constructor input is an associative array of $fieldname => $info,
17 * where $info is an Associative Array with any of the following:
19 * 'class' -- the subclass of HTMLFormField that will be used
20 * to create the object. *NOT* the CSS class!
21 * 'type' -- roughly translates into the <select> type attribute.
22 * if 'class' is not specified, this is used as a map
23 * through HTMLForm::$typeMappings to get the class name.
24 * 'default' -- default value when the form is displayed
25 * 'id' -- HTML id attribute
26 * 'cssclass' -- CSS class
27 * 'options' -- varies according to the specific object.
28 * 'label-message' -- message key for a message to use as the label.
29 * can be an array of msg key and then parameters to
31 * 'label' -- alternatively, a raw text message. Overridden by
33 * 'help-message' -- message key for a message to use as a help text.
34 * can be an array of msg key and then parameters to
36 * Overwrites 'help-messages'.
37 * 'help-messages' -- array of message key. As above, each item can
38 * be an array of msg key and then parameters.
39 * Overwrites 'help-message'.
40 * 'required' -- passed through to the object, indicating that it
41 * is a required field.
42 * 'size' -- the length of text fields
43 * 'filter-callback -- a function name to give you the chance to
44 * massage the inputted value before it's processed.
45 * @see HTMLForm::filter()
46 * 'validation-callback' -- a function name to give you the chance
47 * to impose extra validation on the field input.
48 * @see HTMLForm::validate()
49 * 'name' -- By default, the 'name' attribute of the input field
50 * is "wp{$fieldname}". If you want a different name
51 * (eg one without the "wp" prefix), specify it here and
52 * it will be used without modification.
54 * TODO: Document 'section' / 'subsection' stuff
58 # A mapping of 'type' inputs onto standard HTMLFormField subclasses
59 static $typeMappings = array(
60 'text' => 'HTMLTextField',
61 'textarea' => 'HTMLTextAreaField',
62 'select' => 'HTMLSelectField',
63 'radio' => 'HTMLRadioField',
64 'multiselect' => 'HTMLMultiSelectField',
65 'check' => 'HTMLCheckField',
66 'toggle' => 'HTMLCheckField',
67 'int' => 'HTMLIntField',
68 'float' => 'HTMLFloatField',
69 'info' => 'HTMLInfoField',
70 'selectorother' => 'HTMLSelectOrOtherField',
71 'selectandother' => 'HTMLSelectAndOtherField',
72 'submit' => 'HTMLSubmitField',
73 'hidden' => 'HTMLHiddenField',
74 'edittools' => 'HTMLEditTools',
76 # HTMLTextField will output the correct type="" attribute automagically.
77 # There are about four zillion other HTML5 input types, like url, but
78 # we don't use those at the moment, so no point in adding all of them.
79 'email' => 'HTMLTextField',
80 'password' => 'HTMLTextField',
83 protected $mMessagePrefix;
84 protected $mFlatFields;
85 protected $mFieldTree;
86 protected $mShowReset = false;
89 protected $mSubmitCallback;
90 protected $mValidationErrorMessage;
93 protected $mHeader = '';
94 protected $mFooter = '';
95 protected $mSectionHeaders = array();
96 protected $mSectionFooters = array();
97 protected $mPost = '';
100 protected $mSubmitID;
101 protected $mSubmitName;
102 protected $mSubmitText;
103 protected $mSubmitTooltip;
105 protected $mContext; // <! RequestContext
107 protected $mMethod = 'post';
109 protected $mUseMultipart = false;
110 protected $mHiddenFields = array();
111 protected $mButtons = array();
113 protected $mWrapperLegend = false;
116 * Build a new HTMLForm from an array of field attributes
117 * @param $descriptor Array of Field constructs, as described above
118 * @param $context RequestContext available since 1.18, will become compulsory in 1.19.
119 * Obviates the need to call $form->setTitle()
120 * @param $messagePrefix String a prefix to go in front of default messages
122 public function __construct( $descriptor, /*RequestContext*/ $context = null, $messagePrefix = '' ) {
123 if( $context instanceof RequestContext
){
124 $this->mContext
= $context;
125 $this->mTitle
= false; // We don't need them to set a title
126 $this->mMessagePrefix
= $messagePrefix;
129 if( is_string( $context ) && $messagePrefix === '' ){
130 // it's actually $messagePrefix
131 $this->mMessagePrefix
= $context;
135 // Expand out into a tree.
136 $loadedDescriptor = array();
137 $this->mFlatFields
= array();
139 foreach ( $descriptor as $fieldname => $info ) {
140 $section = isset( $info['section'] )
144 if ( isset( $info['type'] ) && $info['type'] == 'file' ) {
145 $this->mUseMultipart
= true;
148 $field = self
::loadInputFromParameters( $fieldname, $info );
149 $field->mParent
= $this;
151 $setSection =& $loadedDescriptor;
153 $sectionParts = explode( '/', $section );
155 while ( count( $sectionParts ) ) {
156 $newName = array_shift( $sectionParts );
158 if ( !isset( $setSection[$newName] ) ) {
159 $setSection[$newName] = array();
162 $setSection =& $setSection[$newName];
166 $setSection[$fieldname] = $field;
167 $this->mFlatFields
[$fieldname] = $field;
170 $this->mFieldTree
= $loadedDescriptor;
174 * Add the HTMLForm-specific JavaScript, if it hasn't been
176 * @deprecated since 1.18 load modules with ResourceLoader instead
178 static function addJS() { }
181 * Initialise a new Object for the field
182 * @param $descriptor input Descriptor, as described above
183 * @return HTMLFormField subclass
185 static function loadInputFromParameters( $fieldname, $descriptor ) {
186 if ( isset( $descriptor['class'] ) ) {
187 $class = $descriptor['class'];
188 } elseif ( isset( $descriptor['type'] ) ) {
189 $class = self
::$typeMappings[$descriptor['type']];
190 $descriptor['class'] = $class;
196 throw new MWException( "Descriptor with no class: " . print_r( $descriptor, true ) );
199 $descriptor['fieldname'] = $fieldname;
201 $obj = new $class( $descriptor );
207 * Prepare form for submission
209 function prepareForm() {
210 # Check if we have the info we need
211 if ( !$this->mTitle
instanceof Title
&& $this->mTitle
!== false ) {
212 throw new MWException( "You must call setTitle() on an HTMLForm" );
215 # Load data from the request.
220 * Try submitting, with edit token check first
221 * @return Status|boolean
223 function tryAuthorizedSubmit() {
224 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
227 if ( $this->getMethod() != 'post' ||
$this->getUser()->matchEditToken( $editToken ) ) {
228 $result = $this->trySubmit();
234 * The here's-one-I-made-earlier option: do the submission if
235 * posted, or display the form with or without funky valiation
237 * @return Bool or Status whether submission was successful.
240 $this->prepareForm();
242 $result = $this->tryAuthorizedSubmit();
243 if ( $result === true ||
( $result instanceof Status
&& $result->isGood() ) ){
247 $this->displayForm( $result );
252 * Validate all the fields, and call the submision callback
253 * function if everything is kosher.
254 * @return Mixed Bool true == Successful submission, Bool false
255 * == No submission attempted, anything else == Error to
258 function trySubmit() {
259 # Check for validation
260 foreach ( $this->mFlatFields
as $fieldname => $field ) {
261 if ( !empty( $field->mParams
['nodata'] ) ) {
264 if ( $field->validate(
265 $this->mFieldData
[$fieldname],
269 return isset( $this->mValidationErrorMessage
)
270 ?
$this->mValidationErrorMessage
271 : array( 'htmlform-invalid-input' );
275 $callback = $this->mSubmitCallback
;
277 $data = $this->filterDataForSubmit( $this->mFieldData
);
279 $res = call_user_func( $callback, $data );
285 * Set a callback to a function to do something with the form
286 * once it's been successfully validated.
287 * @param $cb String function name. The function will be passed
288 * the output from HTMLForm::filterDataForSubmit, and must
289 * return Bool true on success, Bool false if no submission
290 * was attempted, or String HTML output to display on error.
292 function setSubmitCallback( $cb ) {
293 $this->mSubmitCallback
= $cb;
297 * Set a message to display on a validation error.
298 * @param $msg Mixed String or Array of valid inputs to wfMsgExt()
299 * (so each entry can be either a String or Array)
301 function setValidationErrorMessage( $msg ) {
302 $this->mValidationErrorMessage
= $msg;
306 * Set the introductory message, overwriting any existing message.
307 * @param $msg String complete text of message to display
309 function setIntro( $msg ) { $this->mPre
= $msg; }
312 * Add introductory text.
313 * @param $msg String complete text of message to display
315 function addPreText( $msg ) { $this->mPre
.= $msg; }
318 * Add header text, inside the form.
319 * @param $msg String complete text of message to display
320 * @param $section The section to add the header to
322 function addHeaderText( $msg, $section = null ) {
323 if ( is_null( $section ) ) {
324 $this->mHeader
.= $msg;
326 if ( !isset( $this->mSectionHeaders
[$section] ) ) {
327 $this->mSectionHeaders
[$section] = '';
329 $this->mSectionHeaders
[$section] .= $msg;
334 * Add footer text, inside the form.
335 * @param $msg String complete text of message to display
336 * @param $section string The section to add the footer text to
338 function addFooterText( $msg, $section = null ) {
339 if ( is_null( $section ) ) {
340 $this->mFooter
.= $msg;
342 if ( !isset( $this->mSectionFooters
[$section] ) ) {
343 $this->mSectionFooters
[$section] = '';
345 $this->mSectionFooters
[$section] .= $msg;
350 * Add text to the end of the display.
351 * @param $msg String complete text of message to display
353 function addPostText( $msg ) { $this->mPost
.= $msg; }
356 * Add a hidden field to the output
357 * @param $name String field name. This will be used exactly as entered
358 * @param $value String field value
359 * @param $attribs Array
361 public function addHiddenField( $name, $value, $attribs = array() ) {
362 $attribs +
= array( 'name' => $name );
363 $this->mHiddenFields
[] = array( $value, $attribs );
366 public function addButton( $name, $value, $id = null, $attribs = null ) {
367 $this->mButtons
[] = compact( 'name', 'value', 'id', 'attribs' );
371 * Display the form (sending to wgOut), with an appropriate error
372 * message or stack of messages, and any validation errors, etc.
373 * @param $submitResult Mixed output from HTMLForm::trySubmit()
375 function displayForm( $submitResult ) {
376 # For good measure (it is the default)
377 $this->getOutput()->preventClickjacking();
378 $this->getOutput()->addModules( 'mediawiki.htmlform' );
381 . $this->getErrors( $submitResult )
384 . $this->getHiddenFields()
385 . $this->getButtons()
389 $html = $this->wrapForm( $html );
391 $this->getOutput()->addHTML( ''
399 * Wrap the form innards in an actual <form> element
400 * @param $html String HTML contents to wrap.
401 * @return String wrapped HTML.
403 function wrapForm( $html ) {
405 # Include a <fieldset> wrapper for style, if requested.
406 if ( $this->mWrapperLegend
!== false ) {
407 $html = Xml
::fieldset( $this->mWrapperLegend
, $html );
409 # Use multipart/form-data
410 $encType = $this->mUseMultipart
411 ?
'multipart/form-data'
412 : 'application/x-www-form-urlencoded';
415 'action' => $this->getTitle()->getFullURL(),
416 'method' => $this->mMethod
,
417 'class' => 'visualClear',
418 'enctype' => $encType,
420 if ( !empty( $this->mId
) ) {
421 $attribs['id'] = $this->mId
;
424 return Html
::rawElement( 'form', $attribs, $html );
428 * Get the hidden fields that should go inside the form.
429 * @return String HTML.
431 function getHiddenFields() {
433 if( $this->getMethod() == 'post' ){
434 $html .= Html
::hidden( 'wpEditToken', $this->getUser()->editToken(), array( 'id' => 'wpEditToken' ) ) . "\n";
435 $html .= Html
::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
438 foreach ( $this->mHiddenFields
as $data ) {
439 list( $value, $attribs ) = $data;
440 $html .= Html
::hidden( $attribs['name'], $value, $attribs ) . "\n";
447 * Get the submit and (potentially) reset buttons.
448 * @return String HTML.
450 function getButtons() {
454 if ( isset( $this->mSubmitID
) ) {
455 $attribs['id'] = $this->mSubmitID
;
458 if ( isset( $this->mSubmitName
) ) {
459 $attribs['name'] = $this->mSubmitName
;
462 if ( isset( $this->mSubmitTooltip
) ) {
463 $attribs +
= Linker
::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip
);
466 $attribs['class'] = 'mw-htmlform-submit';
468 $html .= Xml
::submitButton( $this->getSubmitText(), $attribs ) . "\n";
470 if ( $this->mShowReset
) {
471 $html .= Html
::element(
475 'value' => wfMsg( 'htmlform-reset' )
480 foreach ( $this->mButtons
as $button ) {
483 'name' => $button['name'],
484 'value' => $button['value']
487 if ( $button['attribs'] ) {
488 $attrs +
= $button['attribs'];
491 if ( isset( $button['id'] ) ) {
492 $attrs['id'] = $button['id'];
495 $html .= Html
::element( 'input', $attrs );
502 * Get the whole body of the form.
505 return $this->displaySection( $this->mFieldTree
);
509 * Format and display an error message stack.
510 * @param $errors String|Array|Status
513 function getErrors( $errors ) {
514 if ( $errors instanceof Status
) {
515 if ( $errors->isOK() ) {
518 $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
520 } elseif ( is_array( $errors ) ) {
521 $errorstr = $this->formatErrors( $errors );
527 ? Html
::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
532 * Format a stack of error messages into a single HTML string
533 * @param $errors Array of message keys/values
534 * @return String HTML, a <ul> list of errors
536 public static function formatErrors( $errors ) {
539 foreach ( $errors as $error ) {
540 if ( is_array( $error ) ) {
541 $msg = array_shift( $error );
547 $errorstr .= Html
::rawElement(
550 wfMsgExt( $msg, array( 'parseinline' ), $error )
554 $errorstr = Html
::rawElement( 'ul', array(), $errorstr );
560 * Set the text for the submit button
561 * @param $t String plaintext.
563 function setSubmitText( $t ) {
564 $this->mSubmitText
= $t;
568 * Get the text for the submit button, either customised or a default.
569 * @return unknown_type
571 function getSubmitText() {
572 return $this->mSubmitText
574 : wfMsg( 'htmlform-submit' );
577 public function setSubmitName( $name ) {
578 $this->mSubmitName
= $name;
581 public function setSubmitTooltip( $name ) {
582 $this->mSubmitTooltip
= $name;
586 * Set the id for the submit button.
588 * @todo FIXME: Integrity of $t is *not* validated
590 function setSubmitID( $t ) {
591 $this->mSubmitID
= $t;
594 public function setId( $id ) {
598 * Prompt the whole form to be wrapped in a <fieldset>, with
599 * this text as its <legend> element.
600 * @param $legend String HTML to go inside the <legend> element.
603 public function setWrapperLegend( $legend ) { $this->mWrapperLegend
= $legend; }
606 * Set the prefix for various default messages
607 * TODO: currently only used for the <fieldset> legend on forms
608 * with multiple sections; should be used elsewhre?
611 function setMessagePrefix( $p ) {
612 $this->mMessagePrefix
= $p;
616 * Set the title for form submission
617 * @param $t Title of page the form is on/should be posted to
619 function setTitle( $t ) {
627 function getTitle() {
628 return $this->mTitle
=== false
629 ?
$this->getContext()->getTitle()
634 * @return RequestContext
636 public function getContext(){
637 return $this->mContext
instanceof RequestContext
639 : RequestContext
::getMain();
645 public function getOutput(){
646 return $this->getContext()->getOutput();
652 public function getRequest(){
653 return $this->getContext()->getRequest();
659 public function getUser(){
660 return $this->getContext()->getUser();
664 * Set the method used to submit the form
665 * @param $method String
667 public function setMethod( $method='post' ){
668 $this->mMethod
= $method;
671 public function getMethod(){
672 return $this->mMethod
;
679 function displaySection( $fields, $sectionName = '', $displayTitle = false ) {
681 $subsectionHtml = '';
682 $hasLeftColumn = false;
684 foreach ( $fields as $key => $value ) {
685 if ( is_object( $value ) ) {
686 $v = empty( $value->mParams
['nodata'] )
687 ?
$this->mFieldData
[$key]
688 : $value->getDefault();
689 $tableHtml .= $value->getTableRow( $v );
691 if ( $value->getLabel() != ' ' )
692 $hasLeftColumn = true;
693 } elseif ( is_array( $value ) ) {
694 $section = $this->displaySection( $value, $key );
695 $legend = $this->getLegend( $key );
696 if ( isset( $this->mSectionHeaders
[$key] ) ) {
697 $section = $this->mSectionHeaders
[$key] . $section;
699 if ( isset( $this->mSectionFooters
[$key] ) ) {
700 $section .= $this->mSectionFooters
[$key];
702 $attributes = array();
703 if ( $displayTitle ) {
704 $attributes["title"] = $key;
706 $subsectionHtml .= Xml
::fieldset( $legend, $section, $attributes ) . "\n";
712 if ( !$hasLeftColumn ) { // Avoid strange spacing when no labels exist
713 $classes[] = 'mw-htmlform-nolabel';
717 'class' => implode( ' ', $classes ),
720 if ( $sectionName ) {
721 $attribs['id'] = Sanitizer
::escapeId( "mw-htmlform-$sectionName" );
724 $tableHtml = Html
::rawElement( 'table', $attribs,
725 Html
::rawElement( 'tbody', array(), "\n$tableHtml\n" ) ) . "\n";
727 return $subsectionHtml . "\n" . $tableHtml;
731 * Construct the form fields from the Descriptor array
733 function loadData() {
734 $fieldData = array();
736 foreach ( $this->mFlatFields
as $fieldname => $field ) {
737 if ( !empty( $field->mParams
['nodata'] ) ) {
739 } elseif ( !empty( $field->mParams
['disabled'] ) ) {
740 $fieldData[$fieldname] = $field->getDefault();
742 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
747 foreach ( $fieldData as $name => &$value ) {
748 $field = $this->mFlatFields
[$name];
749 $value = $field->filter( $value, $this->mFlatFields
);
752 $this->mFieldData
= $fieldData;
756 * Stop a reset button being shown for this form
757 * @param $suppressReset Bool set to false to re-enable the
760 function suppressReset( $suppressReset = true ) {
761 $this->mShowReset
= !$suppressReset;
765 * Overload this if you want to apply special filtration routines
766 * to the form as a whole, after it's submitted but before it's
769 * @return unknown_type
771 function filterDataForSubmit( $data ) {
776 * Get a string to go in the <legend> of a section fieldset. Override this if you
777 * want something more complicated
781 public function getLegend( $key ) {
782 return wfMsg( "{$this->mMessagePrefix}-$key" );
787 * The parent class to generate form fields. Any field type should
788 * be a subclass of this.
790 abstract class HTMLFormField
{
792 protected $mValidationCallback;
793 protected $mFilterCallback;
796 protected $mLabel; # String label. Set on construction
798 protected $mClass = '';
807 * This function must be implemented to return the HTML to generate
808 * the input object itself. It should not implement the surrounding
809 * table cells/rows, or labels/help messages.
810 * @param $value String the value to set the input to; eg a default
811 * text for a text input.
812 * @return String valid HTML.
814 abstract function getInputHTML( $value );
817 * Override this function to add specific validation checks on the
818 * field input. Don't forget to call parent::validate() to ensure
819 * that the user-defined callback mValidationCallback is still run
820 * @param $value String the value the field was submitted with
821 * @param $alldata Array the data collected from the form
822 * @return Mixed Bool true on success, or String error to display.
824 function validate( $value, $alldata ) {
825 if ( isset( $this->mValidationCallback
) ) {
826 return call_user_func( $this->mValidationCallback
, $value, $alldata );
829 if ( isset( $this->mParams
['required'] ) && $value === '' ) {
830 return wfMsgExt( 'htmlform-required', 'parseinline' );
836 function filter( $value, $alldata ) {
837 if ( isset( $this->mFilterCallback
) ) {
838 $value = call_user_func( $this->mFilterCallback
, $value, $alldata );
845 * Should this field have a label, or is there no input element with the
846 * appropriate id for the label to point to?
848 * @return bool True to output a label, false to suppress
850 protected function needsLabel() {
855 * Get the value that this input has been set to from a posted form,
856 * or the input's default value if it has not been set.
857 * @param $request WebRequest
858 * @return String the value
860 function loadDataFromRequest( $request ) {
861 if ( $request->getCheck( $this->mName
) ) {
862 return $request->getText( $this->mName
);
864 return $this->getDefault();
869 * Initialise the object
870 * @param $params array Associative Array. See HTMLForm doc for syntax.
872 function __construct( $params ) {
873 $this->mParams
= $params;
875 # Generate the label from a message, if possible
876 if ( isset( $params['label-message'] ) ) {
877 $msgInfo = $params['label-message'];
879 if ( is_array( $msgInfo ) ) {
880 $msg = array_shift( $msgInfo );
886 $this->mLabel
= wfMsgExt( $msg, 'parseinline', $msgInfo );
887 } elseif ( isset( $params['label'] ) ) {
888 $this->mLabel
= $params['label'];
891 $this->mName
= "wp{$params['fieldname']}";
892 if ( isset( $params['name'] ) ) {
893 $this->mName
= $params['name'];
896 $validName = Sanitizer
::escapeId( $this->mName
);
897 if ( $this->mName
!= $validName && !isset( $params['nodata'] ) ) {
898 throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__
);
901 $this->mID
= "mw-input-{$this->mName}";
903 if ( isset( $params['default'] ) ) {
904 $this->mDefault
= $params['default'];
907 if ( isset( $params['id'] ) ) {
909 $validId = Sanitizer
::escapeId( $id );
911 if ( $id != $validId ) {
912 throw new MWException( "Invalid id '$id' passed to " . __METHOD__
);
918 if ( isset( $params['cssclass'] ) ) {
919 $this->mClass
= $params['cssclass'];
922 if ( isset( $params['validation-callback'] ) ) {
923 $this->mValidationCallback
= $params['validation-callback'];
926 if ( isset( $params['filter-callback'] ) ) {
927 $this->mFilterCallback
= $params['filter-callback'];
932 * Get the complete table row for the input, including help text,
933 * labels, and whatever.
934 * @param $value String the value to set the input to.
935 * @return String complete HTML table row.
937 function getTableRow( $value ) {
938 # Check for invalid data.
940 $errors = $this->validate( $value, $this->mParent
->mFieldData
);
942 $cellAttributes = array();
943 $verticalLabel = false;
945 if ( !empty($this->mParams
['vertical-label']) ) {
946 $cellAttributes['colspan'] = 2;
947 $verticalLabel = true;
950 if ( $errors === true ||
( !$this->mParent
->getRequest()->wasPosted() && ( $this->mParent
->getMethod() == 'post' ) ) ) {
954 $errors = self
::formatErrors( $errors );
955 $errorClass = 'mw-htmlform-invalid-input';
958 $label = $this->getLabelHtml( $cellAttributes );
959 $field = Html
::rawElement(
961 array( 'class' => 'mw-input' ) +
$cellAttributes,
962 $this->getInputHTML( $value ) . "\n$errors"
965 $fieldType = get_class( $this );
967 if ( $verticalLabel ) {
968 $html = Html
::rawElement( 'tr',
969 array( 'class' => 'mw-htmlform-vertical-label' ), $label );
970 $html .= Html
::rawElement( 'tr',
971 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
974 $html = Html
::rawElement( 'tr',
975 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
981 if ( isset( $this->mParams
['help-message'] ) ) {
982 $msg = wfMessage( $this->mParams
['help-message'] );
983 if ( $msg->exists() ) {
984 $helptext = $msg->parse();
986 } elseif ( isset( $this->mParams
['help-messages'] ) ) {
987 # help-message can be passed a message key (string) or an array containing
988 # a message key and additional parameters. This makes it impossible to pass
989 # an array of message key
990 foreach( $this->mParams
['help-messages'] as $name ) {
991 $msg = wfMessage( $name );
992 if( $msg->exists() ) {
993 $helptext .= $msg->parse(); // append message
996 } elseif ( isset( $this->mParams
['help'] ) ) {
997 $helptext = $this->mParams
['help'];
1000 if ( !is_null( $helptext ) ) {
1001 $row = Html
::rawElement( 'td', array( 'colspan' => 2, 'class' => 'htmlform-tip' ),
1003 $row = Html
::rawElement( 'tr', array(), $row );
1010 function getLabel() {
1011 return $this->mLabel
;
1013 function getLabelHtml( $cellAttributes = array() ) {
1014 # Don't output a for= attribute for labels with no associated input.
1015 # Kind of hacky here, possibly we don't want these to be <label>s at all.
1018 if ( $this->needsLabel() ) {
1019 $for['for'] = $this->mID
;
1022 return Html
::rawElement( 'td', array( 'class' => 'mw-label' ) +
$cellAttributes,
1023 Html
::rawElement( 'label', $for, $this->getLabel() )
1027 function getDefault() {
1028 if ( isset( $this->mDefault
) ) {
1029 return $this->mDefault
;
1036 * Returns the attributes required for the tooltip and accesskey.
1038 * @return array Attributes
1040 public function getTooltipAndAccessKey() {
1041 if ( empty( $this->mParams
['tooltip'] ) ) {
1044 return Linker
::tooltipAndAccesskeyAttribs( $this->mParams
['tooltip'] );
1048 * flatten an array of options to a single array, for instance,
1049 * a set of <options> inside <optgroups>.
1050 * @param $options Associative Array with values either Strings
1052 * @return Array flattened input
1054 public static function flattenOptions( $options ) {
1055 $flatOpts = array();
1057 foreach ( $options as $value ) {
1058 if ( is_array( $value ) ) {
1059 $flatOpts = array_merge( $flatOpts, self
::flattenOptions( $value ) );
1061 $flatOpts[] = $value;
1069 * Formats one or more errors as accepted by field validation-callback.
1070 * @param $errors String|Message|Array of strings or Message instances
1071 * @return String html
1074 protected static function formatErrors( $errors ) {
1075 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1076 $errors = array_shift( $errors );
1079 if ( is_array( $errors ) ) {
1081 foreach ( $errors as $error ) {
1082 if ( $error instanceof Message
) {
1083 $lines[] = Html
::rawElement( 'li', array(), $error->parse() );
1085 $lines[] = Html
::rawElement( 'li', array(), $error );
1088 return Html
::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
1090 if ( $errors instanceof Message
) {
1091 $errors = $errors->parse();
1093 return Html
::rawElement( 'span', array( 'class' => 'error' ), $errors );
1098 class HTMLTextField
extends HTMLFormField
{
1099 function getSize() {
1100 return isset( $this->mParams
['size'] )
1101 ?
$this->mParams
['size']
1105 function getInputHTML( $value ) {
1108 'name' => $this->mName
,
1109 'size' => $this->getSize(),
1111 ) +
$this->getTooltipAndAccessKey();
1113 if ( isset( $this->mParams
['maxlength'] ) ) {
1114 $attribs['maxlength'] = $this->mParams
['maxlength'];
1117 if ( !empty( $this->mParams
['disabled'] ) ) {
1118 $attribs['disabled'] = 'disabled';
1121 # TODO: Enforce pattern, step, required, readonly on the server side as
1123 foreach ( array( 'min', 'max', 'pattern', 'title', 'step',
1124 'placeholder' ) as $param ) {
1125 if ( isset( $this->mParams
[$param] ) ) {
1126 $attribs[$param] = $this->mParams
[$param];
1130 foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' ) as $param ) {
1131 if ( isset( $this->mParams
[$param] ) ) {
1132 $attribs[$param] = '';
1136 # Implement tiny differences between some field variants
1137 # here, rather than creating a new class for each one which
1138 # is essentially just a clone of this one.
1139 if ( isset( $this->mParams
['type'] ) ) {
1140 switch ( $this->mParams
['type'] ) {
1142 $attribs['type'] = 'email';
1145 $attribs['type'] = 'number';
1148 $attribs['type'] = 'number';
1149 $attribs['step'] = 'any';
1154 $attribs['type'] = $this->mParams
['type'];
1159 return Html
::element( 'input', $attribs );
1162 class HTMLTextAreaField
extends HTMLFormField
{
1163 function getCols() {
1164 return isset( $this->mParams
['cols'] )
1165 ?
$this->mParams
['cols']
1169 function getRows() {
1170 return isset( $this->mParams
['rows'] )
1171 ?
$this->mParams
['rows']
1175 function getInputHTML( $value ) {
1178 'name' => $this->mName
,
1179 'cols' => $this->getCols(),
1180 'rows' => $this->getRows(),
1181 ) +
$this->getTooltipAndAccessKey();
1184 if ( !empty( $this->mParams
['disabled'] ) ) {
1185 $attribs['disabled'] = 'disabled';
1188 if ( !empty( $this->mParams
['readonly'] ) ) {
1189 $attribs['readonly'] = 'readonly';
1192 foreach ( array( 'required', 'autofocus' ) as $param ) {
1193 if ( isset( $this->mParams
[$param] ) ) {
1194 $attribs[$param] = '';
1198 return Html
::element( 'textarea', $attribs, $value );
1203 * A field that will contain a numeric value
1205 class HTMLFloatField
extends HTMLTextField
{
1206 function getSize() {
1207 return isset( $this->mParams
['size'] )
1208 ?
$this->mParams
['size']
1212 function validate( $value, $alldata ) {
1213 $p = parent
::validate( $value, $alldata );
1215 if ( $p !== true ) {
1219 $value = trim( $value );
1221 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#real-numbers
1222 # with the addition that a leading '+' sign is ok.
1223 if ( !preg_match( '/^((\+|\-)?\d+(\.\d+)?(E(\+|\-)?\d+)?)?$/i', $value ) ) {
1224 return wfMsgExt( 'htmlform-float-invalid', 'parse' );
1227 # The "int" part of these message names is rather confusing.
1228 # They make equal sense for all numbers.
1229 if ( isset( $this->mParams
['min'] ) ) {
1230 $min = $this->mParams
['min'];
1232 if ( $min > $value ) {
1233 return wfMsgExt( 'htmlform-int-toolow', 'parse', array( $min ) );
1237 if ( isset( $this->mParams
['max'] ) ) {
1238 $max = $this->mParams
['max'];
1240 if ( $max < $value ) {
1241 return wfMsgExt( 'htmlform-int-toohigh', 'parse', array( $max ) );
1250 * A field that must contain a number
1252 class HTMLIntField
extends HTMLFloatField
{
1253 function validate( $value, $alldata ) {
1254 $p = parent
::validate( $value, $alldata );
1256 if ( $p !== true ) {
1260 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#signed-integers
1261 # with the addition that a leading '+' sign is ok. Note that leading zeros
1262 # are fine, and will be left in the input, which is useful for things like
1263 # phone numbers when you know that they are integers (the HTML5 type=tel
1264 # input does not require its value to be numeric). If you want a tidier
1265 # value to, eg, save in the DB, clean it up with intval().
1266 if ( !preg_match( '/^((\+|\-)?\d+)?$/', trim( $value ) )
1268 return wfMsgExt( 'htmlform-int-invalid', 'parse' );
1278 class HTMLCheckField
extends HTMLFormField
{
1279 function getInputHTML( $value ) {
1280 if ( !empty( $this->mParams
['invert'] ) ) {
1284 $attr = $this->getTooltipAndAccessKey();
1285 $attr['id'] = $this->mID
;
1287 if ( !empty( $this->mParams
['disabled'] ) ) {
1288 $attr['disabled'] = 'disabled';
1291 return Xml
::check( $this->mName
, $value, $attr ) . ' ' .
1292 Html
::rawElement( 'label', array( 'for' => $this->mID
), $this->mLabel
);
1296 * For a checkbox, the label goes on the right hand side, and is
1297 * added in getInputHTML(), rather than HTMLFormField::getRow()
1299 function getLabel() {
1304 * @param $request WebRequest
1307 function loadDataFromRequest( $request ) {
1309 if ( isset( $this->mParams
['invert'] ) && $this->mParams
['invert'] ) {
1313 // GetCheck won't work like we want for checks.
1314 if ( $request->getCheck( 'wpEditToken' ) ||
$this->mParent
->getMethod() != 'post' ) {
1315 // XOR has the following truth table, which is what we want
1316 // INVERT VALUE | OUTPUT
1317 // true true | false
1318 // false true | true
1319 // false false | false
1320 // true false | true
1321 return $request->getBool( $this->mName
) xor $invert;
1323 return $this->getDefault();
1329 * A select dropdown field. Basically a wrapper for Xmlselect class
1331 class HTMLSelectField
extends HTMLFormField
{
1332 function validate( $value, $alldata ) {
1333 $p = parent
::validate( $value, $alldata );
1335 if ( $p !== true ) {
1339 $validOptions = HTMLFormField
::flattenOptions( $this->mParams
['options'] );
1341 if ( in_array( $value, $validOptions ) )
1344 return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1347 function getInputHTML( $value ) {
1348 $select = new XmlSelect( $this->mName
, $this->mID
, strval( $value ) );
1350 # If one of the options' 'name' is int(0), it is automatically selected.
1351 # because PHP sucks and thinks int(0) == 'some string'.
1352 # Working around this by forcing all of them to strings.
1353 foreach( $this->mParams
['options'] as &$opt ){
1354 if( is_int( $opt ) ){
1355 $opt = strval( $opt );
1358 unset( $opt ); # PHP keeps $opt around as a reference, which is a bit scary
1360 if ( !empty( $this->mParams
['disabled'] ) ) {
1361 $select->setAttribute( 'disabled', 'disabled' );
1364 $select->addOptions( $this->mParams
['options'] );
1366 return $select->getHTML();
1371 * Select dropdown field, with an additional "other" textbox.
1373 class HTMLSelectOrOtherField
extends HTMLTextField
{
1374 static $jsAdded = false;
1376 function __construct( $params ) {
1377 if ( !in_array( 'other', $params['options'], true ) ) {
1378 $params['options'][wfMsg( 'htmlform-selectorother-other' )] = 'other';
1381 parent
::__construct( $params );
1384 static function forceToStringRecursive( $array ) {
1385 if ( is_array( $array ) ) {
1386 return array_map( array( __CLASS__
, 'forceToStringRecursive' ), $array );
1388 return strval( $array );
1392 function getInputHTML( $value ) {
1393 $valInSelect = false;
1395 if ( $value !== false ) {
1396 $valInSelect = in_array(
1398 HTMLFormField
::flattenOptions( $this->mParams
['options'] )
1402 $selected = $valInSelect ?
$value : 'other';
1404 $opts = self
::forceToStringRecursive( $this->mParams
['options'] );
1406 $select = new XmlSelect( $this->mName
, $this->mID
, $selected );
1407 $select->addOptions( $opts );
1409 $select->setAttribute( 'class', 'mw-htmlform-select-or-other' );
1411 $tbAttribs = array( 'id' => $this->mID
. '-other', 'size' => $this->getSize() );
1413 if ( !empty( $this->mParams
['disabled'] ) ) {
1414 $select->setAttribute( 'disabled', 'disabled' );
1415 $tbAttribs['disabled'] = 'disabled';
1418 $select = $select->getHTML();
1420 if ( isset( $this->mParams
['maxlength'] ) ) {
1421 $tbAttribs['maxlength'] = $this->mParams
['maxlength'];
1424 $textbox = Html
::input(
1425 $this->mName
. '-other',
1426 $valInSelect ?
'' : $value,
1431 return "$select<br />\n$textbox";
1435 * @param $request WebRequest
1438 function loadDataFromRequest( $request ) {
1439 if ( $request->getCheck( $this->mName
) ) {
1440 $val = $request->getText( $this->mName
);
1442 if ( $val == 'other' ) {
1443 $val = $request->getText( $this->mName
. '-other' );
1448 return $this->getDefault();
1454 * Multi-select field
1456 class HTMLMultiSelectField
extends HTMLFormField
{
1458 public function __construct( $params ){
1459 parent
::__construct( $params );
1460 if( isset( $params['flatlist'] ) ){
1461 $this->mClass
.= ' mw-htmlform-multiselect-flatlist';
1465 function validate( $value, $alldata ) {
1466 $p = parent
::validate( $value, $alldata );
1468 if ( $p !== true ) {
1472 if ( !is_array( $value ) ) {
1476 # If all options are valid, array_intersect of the valid options
1477 # and the provided options will return the provided options.
1478 $validOptions = HTMLFormField
::flattenOptions( $this->mParams
['options'] );
1480 $validValues = array_intersect( $value, $validOptions );
1481 if ( count( $validValues ) == count( $value ) ) {
1484 return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1488 function getInputHTML( $value ) {
1489 $html = $this->formatOptions( $this->mParams
['options'], $value );
1494 function formatOptions( $options, $value ) {
1499 if ( !empty( $this->mParams
['disabled'] ) ) {
1500 $attribs['disabled'] = 'disabled';
1503 foreach ( $options as $label => $info ) {
1504 if ( is_array( $info ) ) {
1505 $html .= Html
::rawElement( 'h1', array(), $label ) . "\n";
1506 $html .= $this->formatOptions( $info, $value );
1508 $thisAttribs = array( 'id' => "{$this->mID}-$info", 'value' => $info );
1510 $checkbox = Xml
::check(
1511 $this->mName
. '[]',
1512 in_array( $info, $value, true ),
1513 $attribs +
$thisAttribs );
1514 $checkbox .= ' ' . Html
::rawElement( 'label', array( 'for' => "{$this->mID}-$info" ), $label );
1516 $html .= ' ' . Html
::rawElement( 'div', array( 'class' => 'mw-htmlform-multiselect-item' ), $checkbox );
1524 * @param $request WebRequest
1527 function loadDataFromRequest( $request ) {
1528 if ( $this->mParent
->getMethod() == 'post' ) {
1529 if( $request->wasPosted() ){
1530 # Checkboxes are just not added to the request arrays if they're not checked,
1531 # so it's perfectly possible for there not to be an entry at all
1532 return $request->getArray( $this->mName
, array() );
1534 # That's ok, the user has not yet submitted the form, so show the defaults
1535 return $this->getDefault();
1538 # This is the impossible case: if we look at $_GET and see no data for our
1539 # field, is it because the user has not yet submitted the form, or that they
1540 # have submitted it with all the options unchecked? We will have to assume the
1541 # latter, which basically means that you can't specify 'positive' defaults
1544 return $request->getArray( $this->mName
, array() );
1548 function getDefault() {
1549 if ( isset( $this->mDefault
) ) {
1550 return $this->mDefault
;
1556 protected function needsLabel() {
1562 * Double field with a dropdown list constructed from a system message in the format
1564 * ** <option value>|<option name>
1565 * ** <option value == option name>
1566 * * New Optgroup header
1567 * Plus a text field underneath for an additional reason. The 'value' of the field is
1568 * ""<select>: <extra reason>"", or "<extra reason>" if nothing has been selected in the
1570 * @todo FIXME: If made 'required', only the text field should be compulsory.
1572 class HTMLSelectAndOtherField
extends HTMLSelectField
{
1574 function __construct( $params ) {
1575 if ( array_key_exists( 'other', $params ) ) {
1576 } elseif( array_key_exists( 'other-message', $params ) ){
1577 $params['other'] = wfMessage( $params['other-message'] )->escaped();
1579 $params['other'] = null;
1582 if ( array_key_exists( 'options', $params ) ) {
1583 # Options array already specified
1584 } elseif( array_key_exists( 'options-message', $params ) ){
1585 # Generate options array from a system message
1586 $params['options'] = self
::parseMessage(
1587 wfMessage( $params['options-message'] )->inContentLanguage()->escaped(),
1592 throw new MWException( 'HTMLSelectAndOtherField called without any options' );
1594 $this->mFlatOptions
= self
::flattenOptions( $params['options'] );
1596 parent
::__construct( $params );
1600 * Build a drop-down box from a textual list.
1601 * @param $string String message text
1602 * @param $otherName String name of "other reason" option
1604 * TODO: this is copied from Xml::listDropDown(), deprecate/avoid duplication?
1606 public static function parseMessage( $string, $otherName=null ) {
1607 if( $otherName === null ){
1608 $otherName = wfMessage( 'htmlform-selectorother-other' )->escaped();
1612 $options = array( $otherName => 'other' );
1614 foreach ( explode( "\n", $string ) as $option ) {
1615 $value = trim( $option );
1616 if ( $value == '' ) {
1618 } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
1619 # A new group is starting...
1620 $value = trim( substr( $value, 1 ) );
1622 } elseif ( substr( $value, 0, 2) == '**' ) {
1624 $opt = trim( substr( $value, 2 ) );
1625 $parts = array_map( 'trim', explode( '|', $opt, 2 ) );
1626 if( count( $parts ) === 1 ){
1627 $parts[1] = $parts[0];
1629 if( $optgroup === false ){
1630 $options[$parts[1]] = $parts[0];
1632 $options[$optgroup][$parts[1]] = $parts[0];
1635 # groupless reason list
1637 $parts = array_map( 'trim', explode( '|', $option, 2 ) );
1638 if( count( $parts ) === 1 ){
1639 $parts[1] = $parts[0];
1641 $options[$parts[1]] = $parts[0];
1648 function getInputHTML( $value ) {
1649 $select = parent
::getInputHTML( $value[1] );
1651 $textAttribs = array(
1652 'id' => $this->mID
. '-other',
1653 'size' => $this->getSize(),
1656 foreach ( array( 'required', 'autofocus', 'multiple', 'disabled' ) as $param ) {
1657 if ( isset( $this->mParams
[$param] ) ) {
1658 $textAttribs[$param] = '';
1662 $textbox = Html
::input(
1663 $this->mName
. '-other',
1669 return "$select<br />\n$textbox";
1673 * @param $request WebRequest
1674 * @return Array( <overall message>, <select value>, <text field value> )
1676 function loadDataFromRequest( $request ) {
1677 if ( $request->getCheck( $this->mName
) ) {
1679 $list = $request->getText( $this->mName
);
1680 $text = $request->getText( $this->mName
. '-other' );
1682 if ( $list == 'other' ) {
1684 } elseif( !in_array( $list, $this->mFlatOptions
) ){
1685 # User has spoofed the select form to give an option which wasn't
1686 # in the original offer. Sulk...
1688 } elseif( $text == '' ) {
1691 $final = $list . wfMsgForContent( 'colon-separator' ) . $text;
1695 $final = $this->getDefault();
1698 return array( $final, $list, $text );
1701 function getSize() {
1702 return isset( $this->mParams
['size'] )
1703 ?
$this->mParams
['size']
1707 function validate( $value, $alldata ) {
1708 # HTMLSelectField forces $value to be one of the options in the select
1709 # field, which is not useful here. But we do want the validation further up
1711 $p = parent
::validate( $value[1], $alldata );
1713 if ( $p !== true ) {
1717 if( isset( $this->mParams
['required'] ) && $value[1] === '' ){
1718 return wfMsgExt( 'htmlform-required', 'parseinline' );
1726 * Radio checkbox fields.
1728 class HTMLRadioField
extends HTMLFormField
{
1729 function validate( $value, $alldata ) {
1730 $p = parent
::validate( $value, $alldata );
1732 if ( $p !== true ) {
1736 if ( !is_string( $value ) && !is_int( $value ) ) {
1740 $validOptions = HTMLFormField
::flattenOptions( $this->mParams
['options'] );
1742 if ( in_array( $value, $validOptions ) ) {
1745 return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1750 * This returns a block of all the radio options, in one cell.
1751 * @see includes/HTMLFormField#getInputHTML()
1753 function getInputHTML( $value ) {
1754 $html = $this->formatOptions( $this->mParams
['options'], $value );
1759 function formatOptions( $options, $value ) {
1763 if ( !empty( $this->mParams
['disabled'] ) ) {
1764 $attribs['disabled'] = 'disabled';
1767 # TODO: should this produce an unordered list perhaps?
1768 foreach ( $options as $label => $info ) {
1769 if ( is_array( $info ) ) {
1770 $html .= Html
::rawElement( 'h1', array(), $label ) . "\n";
1771 $html .= $this->formatOptions( $info, $value );
1773 $id = Sanitizer
::escapeId( $this->mID
. "-$info" );
1774 $html .= Xml
::radio(
1778 $attribs +
array( 'id' => $id )
1781 Html
::rawElement( 'label', array( 'for' => $id ), $label );
1783 $html .= "<br />\n";
1790 protected function needsLabel() {
1796 * An information field (text blob), not a proper input.
1798 class HTMLInfoField
extends HTMLFormField
{
1799 function __construct( $info ) {
1800 $info['nodata'] = true;
1802 parent
::__construct( $info );
1805 function getInputHTML( $value ) {
1806 return !empty( $this->mParams
['raw'] ) ?
$value : htmlspecialchars( $value );
1809 function getTableRow( $value ) {
1810 if ( !empty( $this->mParams
['rawrow'] ) ) {
1814 return parent
::getTableRow( $value );
1817 protected function needsLabel() {
1822 class HTMLHiddenField
extends HTMLFormField
{
1823 public function __construct( $params ) {
1824 parent
::__construct( $params );
1826 # Per HTML5 spec, hidden fields cannot be 'required'
1827 # http://dev.w3.org/html5/spec/states-of-the-type-attribute.html#hidden-state
1828 unset( $this->mParams
['required'] );
1831 public function getTableRow( $value ) {
1834 $params['id'] = $this->mID
;
1837 $this->mParent
->addHiddenField(
1846 public function getInputHTML( $value ) { return ''; }
1850 * Add a submit button inline in the form (as opposed to
1851 * HTMLForm::addButton(), which will add it at the end).
1853 class HTMLSubmitField
extends HTMLFormField
{
1855 function __construct( $info ) {
1856 $info['nodata'] = true;
1857 parent
::__construct( $info );
1860 function getInputHTML( $value ) {
1861 return Xml
::submitButton(
1864 'class' => 'mw-htmlform-submit',
1865 'name' => $this->mName
,
1871 protected function needsLabel() {
1876 * Button cannot be invalid
1878 public function validate( $value, $alldata ){
1883 class HTMLEditTools
extends HTMLFormField
{
1884 public function getInputHTML( $value ) {
1888 public function getTableRow( $value ) {
1889 if ( empty( $this->mParams
['message'] ) ) {
1890 $msg = wfMessage( 'edittools' );
1892 $msg = wfMessage( $this->mParams
['message'] );
1893 if ( $msg->isDisabled() ) {
1894 $msg = wfMessage( 'edittools' );
1897 $msg->inContentLanguage();
1900 return '<tr><td></td><td class="mw-input">'
1901 . '<div class="mw-editTools">'
1902 . $msg->parseAsBlock()
1903 . "</div></td></tr>\n";