MediaWiki  master
HTMLForm.php
Go to the documentation of this file.
1 <?php
2 
131 class HTMLForm extends ContextSource {
132  // A mapping of 'type' inputs onto standard HTMLFormField subclasses
133  public static $typeMappings = [
134  'api' => HTMLApiField::class,
135  'text' => HTMLTextField::class,
136  'textwithbutton' => HTMLTextFieldWithButton::class,
137  'textarea' => HTMLTextAreaField::class,
138  'select' => HTMLSelectField::class,
139  'combobox' => HTMLComboboxField::class,
140  'radio' => HTMLRadioField::class,
141  'multiselect' => HTMLMultiSelectField::class,
142  'limitselect' => HTMLSelectLimitField::class,
143  'check' => HTMLCheckField::class,
144  'toggle' => HTMLCheckField::class,
145  'int' => HTMLIntField::class,
146  'float' => HTMLFloatField::class,
147  'info' => HTMLInfoField::class,
148  'selectorother' => HTMLSelectOrOtherField::class,
149  'selectandother' => HTMLSelectAndOtherField::class,
150  'namespaceselect' => HTMLSelectNamespace::class,
151  'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton::class,
152  'tagfilter' => HTMLTagFilter::class,
153  'sizefilter' => HTMLSizeFilterField::class,
154  'submit' => HTMLSubmitField::class,
155  'hidden' => HTMLHiddenField::class,
156  'edittools' => HTMLEditTools::class,
157  'checkmatrix' => HTMLCheckMatrix::class,
158  'cloner' => HTMLFormFieldCloner::class,
159  'autocompleteselect' => HTMLAutoCompleteSelectField::class,
160  'language' => HTMLSelectLanguageField::class,
161  'date' => HTMLDateTimeField::class,
162  'time' => HTMLDateTimeField::class,
163  'datetime' => HTMLDateTimeField::class,
164  'expiry' => HTMLExpiryField::class,
165  // HTMLTextField will output the correct type="" attribute automagically.
166  // There are about four zillion other HTML5 input types, like range, but
167  // we don't use those at the moment, so no point in adding all of them.
168  'email' => HTMLTextField::class,
169  'password' => HTMLTextField::class,
170  'url' => HTMLTextField::class,
171  'title' => HTMLTitleTextField::class,
172  'user' => HTMLUserTextField::class,
173  'usersmultiselect' => HTMLUsersMultiselectField::class,
174  'titlesmultiselect' => HTMLTitlesMultiselectField::class,
175  'namespacesmultiselect' => HTMLNamespacesMultiselectField::class,
176  ];
177 
178  public $mFieldData;
179 
180  protected $mMessagePrefix;
181 
183  protected $mFlatFields = [];
184  protected $mFieldTree = [];
185  protected $mShowReset = false;
186  protected $mShowSubmit = true;
188  protected $mSubmitFlags = [ 'primary', 'progressive' ];
189  protected $mShowCancel = false;
190  protected $mCancelTarget;
191 
192  protected $mSubmitCallback;
194 
195  protected $mPre = '';
196  protected $mHeader = '';
197  protected $mFooter = '';
198  protected $mSectionHeaders = [];
199  protected $mSectionFooters = [];
200  protected $mPost = '';
201  protected $mId;
202  protected $mName;
203  protected $mTableId = '';
204 
205  protected $mSubmitID;
206  protected $mSubmitName;
207  protected $mSubmitText;
208  protected $mSubmitTooltip;
209 
210  protected $mFormIdentifier;
211  protected $mTitle;
212  protected $mMethod = 'post';
213  protected $mWasSubmitted = false;
214 
220  protected $mAction = false;
221 
227  protected $mCollapsible = false;
228 
234  protected $mCollapsed = false;
235 
241  protected $mAutocomplete = null;
242 
243  protected $mUseMultipart = false;
248  protected $mHiddenFields = [];
253  protected $mButtons = [];
254 
255  protected $mWrapperLegend = false;
256  protected $mWrapperAttributes = [];
257 
262  protected $mTokenSalt = '';
263 
271  protected $mSubSectionBeforeFields = true;
272 
278  protected $displayFormat = 'table';
279 
285  'table',
286  'div',
287  'raw',
288  'inline',
289  ];
290 
296  'vform',
297  'ooui',
298  ];
299 
307  public static function factory( $displayFormat, ...$arguments ) {
308  switch ( $displayFormat ) {
309  case 'vform':
310  return new VFormHTMLForm( ...$arguments );
311  case 'ooui':
312  return new OOUIHTMLForm( ...$arguments );
313  default:
314  $form = new self( ...$arguments );
315  $form->setDisplayFormat( $displayFormat );
316  return $form;
317  }
318  }
319 
329  public function __construct( $descriptor, /*IContextSource*/ $context = null,
330  $messagePrefix = ''
331  ) {
332  if ( $context instanceof IContextSource ) {
333  $this->setContext( $context );
334  $this->mTitle = false; // We don't need them to set a title
335  $this->mMessagePrefix = $messagePrefix;
336  } elseif ( $context === null && $messagePrefix !== '' ) {
337  $this->mMessagePrefix = $messagePrefix;
338  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
339  // B/C since 1.18
340  // it's actually $messagePrefix
341  $this->mMessagePrefix = $context;
342  }
343 
344  // Evil hack for mobile :(
345  if (
346  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
347  && $this->displayFormat === 'table'
348  ) {
349  $this->displayFormat = 'div';
350  }
351 
352  $this->addFields( $descriptor );
353  }
354 
364  public function addFields( $descriptor ) {
365  $loadedDescriptor = [];
366 
367  foreach ( $descriptor as $fieldname => $info ) {
368 
369  $section = $info['section'] ?? '';
370 
371  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
372  $this->mUseMultipart = true;
373  }
374 
375  $field = static::loadInputFromParameters( $fieldname, $info, $this );
376 
377  $setSection =& $loadedDescriptor;
378  if ( $section ) {
379  foreach ( explode( '/', $section ) as $newName ) {
380  if ( !isset( $setSection[$newName] ) ) {
381  $setSection[$newName] = [];
382  }
383 
384  $setSection =& $setSection[$newName];
385  }
386  }
387 
388  $setSection[$fieldname] = $field;
389  $this->mFlatFields[$fieldname] = $field;
390  }
391 
392  $this->mFieldTree = array_merge( $this->mFieldTree, $loadedDescriptor );
393 
394  return $this;
395  }
396 
401  public function hasField( $fieldname ) {
402  return isset( $this->mFlatFields[$fieldname] );
403  }
404 
410  public function getField( $fieldname ) {
411  if ( !$this->hasField( $fieldname ) ) {
412  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
413  }
414  return $this->mFlatFields[$fieldname];
415  }
416 
427  public function setDisplayFormat( $format ) {
428  if (
429  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
430  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
431  ) {
432  throw new MWException( 'Cannot change display format after creation, ' .
433  'use HTMLForm::factory() instead' );
434  }
435 
436  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
437  throw new MWException( 'Display format must be one of ' .
438  print_r(
439  array_merge(
440  $this->availableDisplayFormats,
441  $this->availableSubclassDisplayFormats
442  ),
443  true
444  ) );
445  }
446 
447  // Evil hack for mobile :(
448  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
449  $format = 'div';
450  }
451 
452  $this->displayFormat = $format;
453 
454  return $this;
455  }
456 
462  public function getDisplayFormat() {
463  return $this->displayFormat;
464  }
465 
483  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
484  if ( isset( $descriptor['class'] ) ) {
485  $class = $descriptor['class'];
486  } elseif ( isset( $descriptor['type'] ) ) {
487  $class = static::$typeMappings[$descriptor['type']];
488  $descriptor['class'] = $class;
489  } else {
490  $class = null;
491  }
492 
493  if ( !$class ) {
494  throw new MWException( "Descriptor with no class for $fieldname: "
495  . print_r( $descriptor, true ) );
496  }
497 
498  return $class;
499  }
500 
512  public static function loadInputFromParameters( $fieldname, $descriptor,
513  HTMLForm $parent = null
514  ) {
515  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
516 
517  $descriptor['fieldname'] = $fieldname;
518  if ( $parent ) {
519  $descriptor['parent'] = $parent;
520  }
521 
522  # @todo This will throw a fatal error whenever someone try to use
523  # 'class' to feed a CSS class instead of 'cssclass'. Would be
524  # great to avoid the fatal error and show a nice error.
525  return new $class( $descriptor );
526  }
527 
537  public function prepareForm() {
538  # Check if we have the info we need
539  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
540  throw new MWException( 'You must call setTitle() on an HTMLForm' );
541  }
542 
543  # Load data from the request.
544  if (
545  $this->mFormIdentifier === null ||
546  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
547  ) {
548  $this->loadData();
549  } else {
550  $this->mFieldData = [];
551  }
552 
553  return $this;
554  }
555 
560  public function tryAuthorizedSubmit() {
561  $result = false;
562 
563  if ( $this->mFormIdentifier === null ) {
564  $identOkay = true;
565  } else {
566  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
567  }
568 
569  $tokenOkay = false;
570  if ( $this->getMethod() !== 'post' ) {
571  $tokenOkay = true; // no session check needed
572  } elseif ( $this->getRequest()->wasPosted() ) {
573  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
574  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
575  // Session tokens for logged-out users have no security value.
576  // However, if the user gave one, check it in order to give a nice
577  // "session expired" error instead of "permission denied" or such.
578  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
579  } else {
580  $tokenOkay = true;
581  }
582  }
583 
584  if ( $tokenOkay && $identOkay ) {
585  $this->mWasSubmitted = true;
586  $result = $this->trySubmit();
587  }
588 
589  return $result;
590  }
591 
598  public function show() {
599  $this->prepareForm();
600 
601  $result = $this->tryAuthorizedSubmit();
602  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
603  return $result;
604  }
605 
606  $this->displayForm( $result );
607 
608  return false;
609  }
610 
616  public function showAlways() {
617  $this->prepareForm();
618 
619  $result = $this->tryAuthorizedSubmit();
620 
621  $this->displayForm( $result );
622 
623  return $result;
624  }
625 
637  public function trySubmit() {
638  $valid = true;
639  $hoistedErrors = Status::newGood();
640  if ( $this->mValidationErrorMessage ) {
641  foreach ( $this->mValidationErrorMessage as $error ) {
642  $hoistedErrors->fatal( ...$error );
643  }
644  } else {
645  $hoistedErrors->fatal( 'htmlform-invalid-input' );
646  }
647 
648  $this->mWasSubmitted = true;
649 
650  # Check for cancelled submission
651  foreach ( $this->mFlatFields as $fieldname => $field ) {
652  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
653  continue;
654  }
655  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
656  $this->mWasSubmitted = false;
657  return false;
658  }
659  }
660 
661  # Check for validation
662  foreach ( $this->mFlatFields as $fieldname => $field ) {
663  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
664  continue;
665  }
666  if ( $field->isHidden( $this->mFieldData ) ) {
667  continue;
668  }
669  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
670  if ( $res !== true ) {
671  $valid = false;
672  if ( $res !== false && !$field->canDisplayErrors() ) {
673  if ( is_string( $res ) ) {
674  $hoistedErrors->fatal( 'rawmessage', $res );
675  } else {
676  $hoistedErrors->fatal( $res );
677  }
678  }
679  }
680  }
681 
682  if ( !$valid ) {
683  return $hoistedErrors;
684  }
685 
686  $callback = $this->mSubmitCallback;
687  if ( !is_callable( $callback ) ) {
688  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
689  'setSubmitCallback() to set one.' );
690  }
691 
692  $data = $this->filterDataForSubmit( $this->mFieldData );
693 
694  $res = call_user_func( $callback, $data, $this );
695  if ( $res === false ) {
696  $this->mWasSubmitted = false;
697  }
698 
699  return $res;
700  }
701 
713  public function wasSubmitted() {
714  return $this->mWasSubmitted;
715  }
716 
727  public function setSubmitCallback( $cb ) {
728  $this->mSubmitCallback = $cb;
729 
730  return $this;
731  }
732 
741  public function setValidationErrorMessage( $msg ) {
742  $this->mValidationErrorMessage = $msg;
743 
744  return $this;
745  }
746 
754  public function setIntro( $msg ) {
755  $this->setPreText( $msg );
756 
757  return $this;
758  }
759 
768  public function setPreText( $msg ) {
769  $this->mPre = $msg;
770 
771  return $this;
772  }
773 
781  public function addPreText( $msg ) {
782  $this->mPre .= $msg;
783 
784  return $this;
785  }
786 
794  public function getPreText() {
795  return $this->mPre;
796  }
797 
806  public function addHeaderText( $msg, $section = null ) {
807  if ( $section === null ) {
808  $this->mHeader .= $msg;
809  } else {
810  if ( !isset( $this->mSectionHeaders[$section] ) ) {
811  $this->mSectionHeaders[$section] = '';
812  }
813  $this->mSectionHeaders[$section] .= $msg;
814  }
815 
816  return $this;
817  }
818 
828  public function setHeaderText( $msg, $section = null ) {
829  if ( $section === null ) {
830  $this->mHeader = $msg;
831  } else {
832  $this->mSectionHeaders[$section] = $msg;
833  }
834 
835  return $this;
836  }
837 
845  public function getHeaderText( $section = null ) {
846  if ( $section === null ) {
847  return $this->mHeader;
848  } else {
849  return $this->mSectionHeaders[$section] ?? '';
850  }
851  }
852 
861  public function addFooterText( $msg, $section = null ) {
862  if ( $section === null ) {
863  $this->mFooter .= $msg;
864  } else {
865  if ( !isset( $this->mSectionFooters[$section] ) ) {
866  $this->mSectionFooters[$section] = '';
867  }
868  $this->mSectionFooters[$section] .= $msg;
869  }
870 
871  return $this;
872  }
873 
883  public function setFooterText( $msg, $section = null ) {
884  if ( $section === null ) {
885  $this->mFooter = $msg;
886  } else {
887  $this->mSectionFooters[$section] = $msg;
888  }
889 
890  return $this;
891  }
892 
900  public function getFooterText( $section = null ) {
901  if ( $section === null ) {
902  return $this->mFooter;
903  } else {
904  return $this->mSectionFooters[$section] ?? '';
905  }
906  }
907 
915  public function addPostText( $msg ) {
916  $this->mPost .= $msg;
917 
918  return $this;
919  }
920 
928  public function setPostText( $msg ) {
929  $this->mPost = $msg;
930 
931  return $this;
932  }
933 
943  public function addHiddenField( $name, $value, array $attribs = [] ) {
944  $attribs += [ 'name' => $name ];
945  $this->mHiddenFields[] = [ $value, $attribs ];
946 
947  return $this;
948  }
949 
960  public function addHiddenFields( array $fields ) {
961  foreach ( $fields as $name => $value ) {
962  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
963  }
964 
965  return $this;
966  }
967 
995  public function addButton( $data ) {
996  if ( !is_array( $data ) ) {
997  $args = func_get_args();
998  if ( count( $args ) < 2 || count( $args ) > 4 ) {
999  throw new InvalidArgumentException(
1000  'Incorrect number of arguments for deprecated calling style'
1001  );
1002  }
1003  $data = [
1004  'name' => $args[0],
1005  'value' => $args[1],
1006  'id' => $args[2] ?? null,
1007  'attribs' => $args[3] ?? null,
1008  ];
1009  } else {
1010  if ( !isset( $data['name'] ) ) {
1011  throw new InvalidArgumentException( 'A name is required' );
1012  }
1013  if ( !isset( $data['value'] ) ) {
1014  throw new InvalidArgumentException( 'A value is required' );
1015  }
1016  }
1017  $this->mButtons[] = $data + [
1018  'id' => null,
1019  'attribs' => null,
1020  'flags' => null,
1021  'framed' => true,
1022  ];
1023 
1024  return $this;
1025  }
1026 
1036  public function setTokenSalt( $salt ) {
1037  $this->mTokenSalt = $salt;
1038 
1039  return $this;
1040  }
1041 
1054  public function displayForm( $submitResult ) {
1055  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1056  }
1057 
1066  public function getHTML( $submitResult ) {
1067  # For good measure (it is the default)
1068  $this->getOutput()->preventClickjacking();
1069  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1070  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1071 
1072  $html = ''
1073  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1074  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1075  . $this->getHeaderText()
1076  . $this->getBody()
1077  . $this->getHiddenFields()
1078  . $this->getButtons()
1079  . $this->getFooterText();
1080 
1081  $html = $this->wrapForm( $html );
1082 
1083  return '' . $this->mPre . $html . $this->mPost;
1084  }
1085 
1093  public function setCollapsibleOptions( $collapsedByDefault = false ) {
1094  $this->mCollapsible = true;
1095  $this->mCollapsed = $collapsedByDefault;
1096  return $this;
1097  }
1098 
1103  protected function getFormAttributes() {
1104  # Use multipart/form-data
1105  $encType = $this->mUseMultipart
1106  ? 'multipart/form-data'
1107  : 'application/x-www-form-urlencoded';
1108  # Attributes
1109  $attribs = [
1110  'class' => 'mw-htmlform',
1111  'action' => $this->getAction(),
1112  'method' => $this->getMethod(),
1113  'enctype' => $encType,
1114  ];
1115  if ( $this->mId ) {
1116  $attribs['id'] = $this->mId;
1117  }
1118  if ( is_string( $this->mAutocomplete ) ) {
1119  $attribs['autocomplete'] = $this->mAutocomplete;
1120  }
1121  if ( $this->mName ) {
1122  $attribs['name'] = $this->mName;
1123  }
1124  if ( $this->needsJSForHtml5FormValidation() ) {
1125  $attribs['novalidate'] = true;
1126  }
1127  return $attribs;
1128  }
1129 
1137  public function wrapForm( $html ) {
1138  # Include a <fieldset> wrapper for style, if requested.
1139  if ( $this->mWrapperLegend !== false ) {
1140  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1141  $html = Xml::fieldset( $legend, $html, $this->mWrapperAttributes );
1142  }
1143 
1144  return Html::rawElement(
1145  'form',
1146  $this->getFormAttributes(),
1147  $html
1148  );
1149  }
1150 
1155  public function getHiddenFields() {
1156  $html = '';
1157  if ( $this->mFormIdentifier !== null ) {
1158  $html .= Html::hidden(
1159  'wpFormIdentifier',
1160  $this->mFormIdentifier
1161  ) . "\n";
1162  }
1163  if ( $this->getMethod() === 'post' ) {
1164  $html .= Html::hidden(
1165  'wpEditToken',
1166  $this->getUser()->getEditToken( $this->mTokenSalt ),
1167  [ 'id' => 'wpEditToken' ]
1168  ) . "\n";
1169  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1170  }
1171 
1172  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1173  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1174  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1175  }
1176 
1177  foreach ( $this->mHiddenFields as $data ) {
1178  list( $value, $attribs ) = $data;
1179  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1180  }
1181 
1182  return $html;
1183  }
1184 
1189  public function getButtons() {
1190  $buttons = '';
1191  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1192 
1193  if ( $this->mShowSubmit ) {
1194  $attribs = [];
1195 
1196  if ( isset( $this->mSubmitID ) ) {
1197  $attribs['id'] = $this->mSubmitID;
1198  }
1199 
1200  if ( isset( $this->mSubmitName ) ) {
1201  $attribs['name'] = $this->mSubmitName;
1202  }
1203 
1204  if ( isset( $this->mSubmitTooltip ) ) {
1205  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1206  }
1207 
1208  $attribs['class'] = [ 'mw-htmlform-submit' ];
1209 
1210  if ( $useMediaWikiUIEverywhere ) {
1211  foreach ( $this->mSubmitFlags as $flag ) {
1212  $attribs['class'][] = 'mw-ui-' . $flag;
1213  }
1214  $attribs['class'][] = 'mw-ui-button';
1215  }
1216 
1217  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1218  }
1219 
1220  if ( $this->mShowReset ) {
1221  $buttons .= Html::element(
1222  'input',
1223  [
1224  'type' => 'reset',
1225  'value' => $this->msg( 'htmlform-reset' )->text(),
1226  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1227  ]
1228  ) . "\n";
1229  }
1230 
1231  if ( $this->mShowCancel ) {
1232  $target = $this->mCancelTarget ?: Title::newMainPage();
1233  if ( $target instanceof Title ) {
1234  $target = $target->getLocalURL();
1235  }
1236  $buttons .= Html::element(
1237  'a',
1238  [
1239  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1240  'href' => $target,
1241  ],
1242  $this->msg( 'cancel' )->text()
1243  ) . "\n";
1244  }
1245 
1246  // IE<8 has bugs with <button>, so we'll need to avoid them.
1247  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1248 
1249  foreach ( $this->mButtons as $button ) {
1250  $attrs = [
1251  'type' => 'submit',
1252  'name' => $button['name'],
1253  'value' => $button['value']
1254  ];
1255 
1256  if ( isset( $button['label-message'] ) ) {
1257  $label = $this->getMessage( $button['label-message'] )->parse();
1258  } elseif ( isset( $button['label'] ) ) {
1259  $label = htmlspecialchars( $button['label'] );
1260  } elseif ( isset( $button['label-raw'] ) ) {
1261  $label = $button['label-raw'];
1262  } else {
1263  $label = htmlspecialchars( $button['value'] );
1264  }
1265 
1266  if ( $button['attribs'] ) {
1267  $attrs += $button['attribs'];
1268  }
1269 
1270  if ( isset( $button['id'] ) ) {
1271  $attrs['id'] = $button['id'];
1272  }
1273 
1274  if ( $useMediaWikiUIEverywhere ) {
1275  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1276  $attrs['class'][] = 'mw-ui-button';
1277  }
1278 
1279  if ( $isBadIE ) {
1280  $buttons .= Html::element( 'input', $attrs ) . "\n";
1281  } else {
1282  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1283  }
1284  }
1285 
1286  if ( !$buttons ) {
1287  return '';
1288  }
1289 
1290  return Html::rawElement( 'span',
1291  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1292  }
1293 
1298  public function getBody() {
1299  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1300  }
1301 
1310  public function getErrorsOrWarnings( $elements, $elementsType ) {
1311  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1312  throw new DomainException( $elementsType . ' is not a valid type.' );
1313  }
1314  $elementstr = false;
1315  if ( $elements instanceof Status ) {
1316  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1317  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1318  if ( $status->isGood() ) {
1319  $elementstr = '';
1320  } else {
1321  $elementstr = $this->getOutput()->parseAsInterface(
1322  $status->getWikiText()
1323  );
1324  }
1325  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1326  $elementstr = $this->formatErrors( $elements );
1327  } elseif ( $elementsType === 'error' ) {
1328  $elementstr = $elements;
1329  }
1330 
1331  return $elementstr
1332  ? Html::rawElement( 'div', [ 'class' => $elementsType . 'box' ], $elementstr )
1333  : '';
1334  }
1335 
1343  public function formatErrors( $errors ) {
1344  $errorstr = '';
1345 
1346  foreach ( $errors as $error ) {
1347  $errorstr .= Html::rawElement(
1348  'li',
1349  [],
1350  $this->getMessage( $error )->parse()
1351  );
1352  }
1353 
1354  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1355 
1356  return $errorstr;
1357  }
1358 
1366  public function setSubmitText( $t ) {
1367  $this->mSubmitText = $t;
1368 
1369  return $this;
1370  }
1371 
1378  public function setSubmitDestructive() {
1379  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1380 
1381  return $this;
1382  }
1383 
1392  public function setSubmitTextMsg( $msg ) {
1393  if ( !$msg instanceof Message ) {
1394  $msg = $this->msg( $msg );
1395  }
1396  $this->setSubmitText( $msg->text() );
1397 
1398  return $this;
1399  }
1400 
1405  public function getSubmitText() {
1406  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1407  }
1408 
1414  public function setSubmitName( $name ) {
1415  $this->mSubmitName = $name;
1416 
1417  return $this;
1418  }
1419 
1425  public function setSubmitTooltip( $name ) {
1426  $this->mSubmitTooltip = $name;
1427 
1428  return $this;
1429  }
1430 
1439  public function setSubmitID( $t ) {
1440  $this->mSubmitID = $t;
1441 
1442  return $this;
1443  }
1444 
1460  public function setFormIdentifier( $ident ) {
1461  $this->mFormIdentifier = $ident;
1462 
1463  return $this;
1464  }
1465 
1476  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1477  $this->mShowSubmit = !$suppressSubmit;
1478 
1479  return $this;
1480  }
1481 
1488  public function showCancel( $show = true ) {
1489  $this->mShowCancel = $show;
1490  return $this;
1491  }
1492 
1499  public function setCancelTarget( $target ) {
1500  $this->mCancelTarget = $target;
1501  return $this;
1502  }
1503 
1513  public function setTableId( $id ) {
1514  $this->mTableId = $id;
1515 
1516  return $this;
1517  }
1518 
1524  public function setId( $id ) {
1525  $this->mId = $id;
1526 
1527  return $this;
1528  }
1529 
1534  public function setName( $name ) {
1535  $this->mName = $name;
1536 
1537  return $this;
1538  }
1539 
1551  public function setWrapperLegend( $legend ) {
1552  $this->mWrapperLegend = $legend;
1553 
1554  return $this;
1555  }
1556 
1564  public function setWrapperAttributes( $attributes ) {
1565  $this->mWrapperAttributes = $attributes;
1566 
1567  return $this;
1568  }
1569 
1579  public function setWrapperLegendMsg( $msg ) {
1580  if ( !$msg instanceof Message ) {
1581  $msg = $this->msg( $msg );
1582  }
1583  $this->setWrapperLegend( $msg->text() );
1584 
1585  return $this;
1586  }
1587 
1597  public function setMessagePrefix( $p ) {
1598  $this->mMessagePrefix = $p;
1599 
1600  return $this;
1601  }
1602 
1610  public function setTitle( $t ) {
1611  $this->mTitle = $t;
1612 
1613  return $this;
1614  }
1615 
1620  public function getTitle() {
1621  return $this->mTitle === false
1622  ? $this->getContext()->getTitle()
1623  : $this->mTitle;
1624  }
1625 
1633  public function setMethod( $method = 'post' ) {
1634  $this->mMethod = strtolower( $method );
1635 
1636  return $this;
1637  }
1638 
1642  public function getMethod() {
1643  return $this->mMethod;
1644  }
1645 
1655  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1656  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1657  }
1658 
1675  public function displaySection( $fields,
1676  $sectionName = '',
1677  $fieldsetIDPrefix = '',
1678  &$hasUserVisibleFields = false
1679  ) {
1680  if ( $this->mFieldData === null ) {
1681  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1682  . 'You probably called displayForm() without calling prepareForm() first.' );
1683  }
1684 
1685  $displayFormat = $this->getDisplayFormat();
1686 
1687  $html = [];
1688  $subsectionHtml = '';
1689  $hasLabel = false;
1690 
1691  // Conveniently, PHP method names are case-insensitive.
1692  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1693  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1694 
1695  foreach ( $fields as $key => $value ) {
1696  if ( $value instanceof HTMLFormField ) {
1697  $v = array_key_exists( $key, $this->mFieldData )
1698  ? $this->mFieldData[$key]
1699  : $value->getDefault();
1700 
1701  $retval = $value->$getFieldHtmlMethod( $v );
1702 
1703  // check, if the form field should be added to
1704  // the output.
1705  if ( $value->hasVisibleOutput() ) {
1706  $html[] = $retval;
1707 
1708  $labelValue = trim( $value->getLabel() );
1709  if ( $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' && $labelValue !== '' ) {
1710  $hasLabel = true;
1711  }
1712 
1713  $hasUserVisibleFields = true;
1714  }
1715  } elseif ( is_array( $value ) ) {
1716  $subsectionHasVisibleFields = false;
1717  $section =
1718  $this->displaySection( $value,
1719  "mw-htmlform-$key",
1720  "$fieldsetIDPrefix$key-",
1721  $subsectionHasVisibleFields );
1722  $legend = null;
1723 
1724  if ( $subsectionHasVisibleFields === true ) {
1725  // Display the section with various niceties.
1726  $hasUserVisibleFields = true;
1727 
1728  $legend = $this->getLegend( $key );
1729 
1730  $section = $this->getHeaderText( $key ) .
1731  $section .
1732  $this->getFooterText( $key );
1733 
1734  $attributes = [];
1735  if ( $fieldsetIDPrefix ) {
1736  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1737  }
1738  $subsectionHtml .= $this->wrapFieldSetSection(
1739  $legend, $section, $attributes, $fields === $this->mFieldTree
1740  );
1741  } else {
1742  // Just return the inputs, nothing fancy.
1743  $subsectionHtml .= $section;
1744  }
1745  }
1746  }
1747 
1748  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1749 
1750  if ( $subsectionHtml ) {
1751  if ( $this->mSubSectionBeforeFields ) {
1752  return $subsectionHtml . "\n" . $html;
1753  } else {
1754  return $html . "\n" . $subsectionHtml;
1755  }
1756  } else {
1757  return $html;
1758  }
1759  }
1760 
1768  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1769  if ( !$fieldsHtml ) {
1770  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1771  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1772  return '';
1773  }
1774 
1775  $displayFormat = $this->getDisplayFormat();
1776  $html = implode( '', $fieldsHtml );
1777 
1778  if ( $displayFormat === 'raw' ) {
1779  return $html;
1780  }
1781 
1782  $classes = [];
1783 
1784  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1785  $classes[] = 'mw-htmlform-nolabel';
1786  }
1787 
1788  $attribs = [
1789  'class' => implode( ' ', $classes ),
1790  ];
1791 
1792  if ( $sectionName ) {
1793  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1794  }
1795 
1796  if ( $displayFormat === 'table' ) {
1797  return Html::rawElement( 'table',
1798  $attribs,
1799  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1800  } elseif ( $displayFormat === 'inline' ) {
1801  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1802  } else {
1803  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1804  }
1805  }
1806 
1810  public function loadData() {
1811  $fieldData = [];
1812 
1813  foreach ( $this->mFlatFields as $fieldname => $field ) {
1814  $request = $this->getRequest();
1815  if ( $field->skipLoadData( $request ) ) {
1816  continue;
1817  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1818  $fieldData[$fieldname] = $field->getDefault();
1819  } else {
1820  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1821  }
1822  }
1823 
1824  # Filter data.
1825  foreach ( $fieldData as $name => &$value ) {
1826  $field = $this->mFlatFields[$name];
1827  $value = $field->filter( $value, $this->mFlatFields );
1828  }
1829 
1830  $this->mFieldData = $fieldData;
1831  }
1832 
1840  public function suppressReset( $suppressReset = true ) {
1841  $this->mShowReset = !$suppressReset;
1842 
1843  return $this;
1844  }
1845 
1855  public function filterDataForSubmit( $data ) {
1856  return $data;
1857  }
1858 
1867  public function getLegend( $key ) {
1868  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1869  }
1870 
1881  public function setAction( $action ) {
1882  $this->mAction = $action;
1883 
1884  return $this;
1885  }
1886 
1894  public function getAction() {
1895  // If an action is alredy provided, return it
1896  if ( $this->mAction !== false ) {
1897  return $this->mAction;
1898  }
1899 
1900  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1901  // Check whether we are in GET mode and the ArticlePath contains a "?"
1902  // meaning that getLocalURL() would return something like "index.php?title=...".
1903  // As browser remove the query string before submitting GET forms,
1904  // it means that the title would be lost. In such case use wfScript() instead
1905  // and put title in an hidden field (see getHiddenFields()).
1906  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1907  return wfScript();
1908  }
1909 
1910  return $this->getTitle()->getLocalURL();
1911  }
1912 
1923  public function setAutocomplete( $autocomplete ) {
1924  $this->mAutocomplete = $autocomplete;
1925 
1926  return $this;
1927  }
1928 
1935  protected function getMessage( $value ) {
1936  return Message::newFromSpecifier( $value )->setContext( $this );
1937  }
1938 
1948  public function needsJSForHtml5FormValidation() {
1949  foreach ( $this->mFlatFields as $fieldname => $field ) {
1950  if ( $field->needsJSForHtml5FormValidation() ) {
1951  return true;
1952  }
1953  }
1954  return false;
1955  }
1956 }
HTMLFormField [] $mFlatFields
Definition: HTMLForm.php:183
setContext(IContextSource $context)
string [] $mSubmitFlags
Definition: HTMLForm.php:188
showAlways()
Same as self::show with the difference, that the form will be added to the output, no matter, if the validation was good or not.
Definition: HTMLForm.php:616
string null $mAutocomplete
Form attribute autocomplete.
Definition: HTMLForm.php:241
needsJSForHtml5FormValidation()
Whether this form, with its current fields, requires the user agent to have JavaScript enabled for th...
Definition: HTMLForm.php:1948
static $typeMappings
Definition: HTMLForm.php:133
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
prepareForm()
Prepare form for submission.
Definition: HTMLForm.php:537
setSubmitID( $t)
Set the id for the submit button.
Definition: HTMLForm.php:1439
$mWasSubmitted
Definition: HTMLForm.php:213
static getClassFromDescriptor( $fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:483
setPostText( $msg)
Set text at the end of the display.
Definition: HTMLForm.php:928
static newMainPage(MessageLocalizer $localizer=null)
Create a new Title for the Main Page.
Definition: Title.php:646
$mWrapperLegend
Definition: HTMLForm.php:255
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1655
getAction()
Get the value for the action attribute of the form.
Definition: HTMLForm.php:1894
setSubmitName( $name)
Definition: HTMLForm.php:1414
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1488
setFooterText( $msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:883
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:462
$mUseMultipart
Definition: HTMLForm.php:243
The Message class provides methods which fulfil two basic services:
Definition: Message.php:162
setTokenSalt( $salt)
Set the salt for the edit token.
Definition: HTMLForm.php:1036
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
addFooterText( $msg, $section=null)
Add footer text, inside the form.
Definition: HTMLForm.php:861
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher...
Definition: HTMLForm.php:637
setSubmitTooltip( $name)
Definition: HTMLForm.php:1425
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:995
bool $mCollapsed
Whether the form is collapsed by default.
Definition: HTMLForm.php:234
getLegend( $key)
Get a string to go in the "<legend>" of a section fieldset.
Definition: HTMLForm.php:1867
hasField( $fieldname)
Definition: HTMLForm.php:401
displaySection( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1675
$mSubmitCallback
Definition: HTMLForm.php:192
$mSubmitTooltip
Definition: HTMLForm.php:208
IContextSource $context
setCollapsibleOptions( $collapsedByDefault=false)
Enable collapsible mode, and set whether the form is collapsed by default.
Definition: HTMLForm.php:1093
setId( $id)
Definition: HTMLForm.php:1524
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:284
getHiddenFields()
Get the hidden fields that should go inside the form.
Definition: HTMLForm.php:1155
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:262
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:960
bool string $mAction
Form action URL.
Definition: HTMLForm.php:220
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1633
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
$mValidationErrorMessage
Definition: HTMLForm.php:193
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: HTMLForm.php:512
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:329
displayForm( $submitResult)
Display the form (sending to the context&#39;s OutputPage object), with an appropriate error message or s...
Definition: HTMLForm.php:1054
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:278
setSubmitText( $t)
Set the text for the submit button.
Definition: HTMLForm.php:1366
if( $line===false) $args
Definition: mcc.php:124
show()
The here&#39;s-one-I-made-earlier option: do the submission if posted, or display the form with or withou...
Definition: HTMLForm.php:598
static $mFieldData
Definition: HTMLForm.php:135
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1499
static factory( $displayFormat,... $arguments)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:307
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:943
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1378
getHTML( $submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1066
getMessage( $value)
Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.
Definition: HTMLForm.php:1935
$mWrapperAttributes
Definition: HTMLForm.php:256
static escapeIdForAttribute( $id, $mode=self::ID_PRIMARY)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid HTM...
Definition: Sanitizer.php:1257
setFormIdentifier( $ident)
Set an internal identifier for this form.
Definition: HTMLForm.php:1460
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:609
setTableId( $id)
Set the id of the <table> or outermost <div> element.
Definition: HTMLForm.php:1513
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
getTitle()
Get the title.
Definition: HTMLForm.php:1620
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:828
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
formatErrors( $errors)
Format a stack of error messages into a single HTML string.
Definition: HTMLForm.php:1343
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: HTMLForm.php:1137
getContext()
Get the base IContextSource object.
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1103
filterDataForSubmit( $data)
Overload this if you want to apply special filtration routines to the form as a whole, after it&#39;s submitted but before it&#39;s processed.
Definition: HTMLForm.php:1855
setValidationErrorMessage( $msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:741
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields&#39; HTML, merging it and wrapping.
Definition: HTMLForm.php:1768
array $availableSubclassDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:295
addPreText( $msg)
Add HTML to introductory message.
Definition: HTMLForm.php:781
setMessagePrefix( $p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1597
array [] $mHiddenFields
-var array<int,array{0:string,1:array}>
Definition: HTMLForm.php:248
setSubmitCallback( $cb)
Set a callback to a function to do something with the form once it&#39;s been successfully validated...
Definition: HTMLForm.php:727
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1405
$mCancelTarget
Definition: HTMLForm.php:190
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:713
$mFormIdentifier
Definition: HTMLForm.php:210
array [] $mButtons
-var array<array{name:string,value:string,label-message?:string|string[]|MessageSpecifier,label?:string,label-raw?:string,id?:string,attribs?:array,flags?:string|string[],framed?:bool}>
Definition: HTMLForm.php:253
setWrapperAttributes( $attributes)
For internal use only.
Definition: HTMLForm.php:1564
Compact stacked vertical format for forms.
getField( $fieldname)
Definition: HTMLForm.php:410
$mSectionFooters
Definition: HTMLForm.php:199
getPreText()
Get the introductory message HTML.
Definition: HTMLForm.php:794
static newFromSpecifier( $value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:430
addFields( $descriptor)
Add fields to the form.
Definition: HTMLForm.php:364
msg( $key,... $params)
Get a Message object with context set Parameters are the same as wfMessage()
loadData()
Construct the form fields from the Descriptor array.
Definition: HTMLForm.php:1810
setAction( $action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1881
suppressReset( $suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1840
getFooterText( $section=null)
Get footer text.
Definition: HTMLForm.php:900
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:802
getErrorsOrWarnings( $elements, $elementsType)
Returns a formatted list of errors or warnings from the given elements.
Definition: HTMLForm.php:1310
getHeaderText( $section=null)
Get header text.
Definition: HTMLForm.php:845
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:560
Compact stacked vertical format for forms, implemented using OOUI widgets.
setIntro( $msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:754
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1392
$mSectionHeaders
Definition: HTMLForm.php:198
setAutocomplete( $autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1923
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element...
Definition: HTMLForm.php:1579
$mMessagePrefix
Definition: HTMLForm.php:180
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1298
setPreText( $msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:768
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1476
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2191
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:806
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1189
setDisplayFormat( $format)
Set format in which to display the form.
Definition: HTMLForm.php:427
bool $mCollapsible
Whether the form can be collapsed.
Definition: HTMLForm.php:227
$mSubSectionBeforeFields
If true, sections that contain both fields and subsections will render their subsections before their...
Definition: HTMLForm.php:271
addPostText( $msg)
Add text to the end of the display.
Definition: HTMLForm.php:915
setName( $name)
Definition: HTMLForm.php:1534
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element...
Definition: HTMLForm.php:1551
setTitle( $t)
Set the title for form submission.
Definition: HTMLForm.php:1610