MediaWiki  master
HTMLForm.php
Go to the documentation of this file.
1 <?php
2 
25 
133 class HTMLForm extends ContextSource {
134  // A mapping of 'type' inputs onto standard HTMLFormField subclasses
135  public static $typeMappings = [
136  'api' => HTMLApiField::class,
138  'textwithbutton' => HTMLTextFieldWithButton::class,
139  'textarea' => HTMLTextAreaField::class,
140  'select' => HTMLSelectField::class,
141  'combobox' => HTMLComboboxField::class,
142  'radio' => HTMLRadioField::class,
143  'multiselect' => HTMLMultiSelectField::class,
144  'limitselect' => HTMLSelectLimitField::class,
145  'check' => HTMLCheckField::class,
146  'toggle' => HTMLCheckField::class,
147  'int' => HTMLIntField::class,
148  'float' => HTMLFloatField::class,
149  'info' => HTMLInfoField::class,
150  'selectorother' => HTMLSelectOrOtherField::class,
151  'selectandother' => HTMLSelectAndOtherField::class,
152  'namespaceselect' => HTMLSelectNamespace::class,
153  'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton::class,
154  'tagfilter' => HTMLTagFilter::class,
155  'sizefilter' => HTMLSizeFilterField::class,
156  'submit' => HTMLSubmitField::class,
157  'hidden' => HTMLHiddenField::class,
158  'edittools' => HTMLEditTools::class,
159  'checkmatrix' => HTMLCheckMatrix::class,
160  'cloner' => HTMLFormFieldCloner::class,
161  'autocompleteselect' => HTMLAutoCompleteSelectField::class,
162  'date' => HTMLDateTimeField::class,
163  'time' => HTMLDateTimeField::class,
164  'datetime' => HTMLDateTimeField::class,
165  'expiry' => HTMLExpiryField::class,
166  // HTMLTextField will output the correct type="" attribute automagically.
167  // There are about four zillion other HTML5 input types, like range, but
168  // we don't use those at the moment, so no point in adding all of them.
169  'email' => HTMLTextField::class,
170  'password' => HTMLTextField::class,
171  'url' => HTMLTextField::class,
172  'title' => HTMLTitleTextField::class,
173  'user' => HTMLUserTextField::class,
174  'usersmultiselect' => HTMLUsersMultiselectField::class,
175  ];
176 
177  public $mFieldData;
178 
179  protected $mMessagePrefix;
180 
182  protected $mFlatFields;
183 
184  protected $mFieldTree;
185  protected $mShowReset = false;
186  protected $mShowSubmit = true;
187  protected $mSubmitFlags = [ 'primary', 'progressive' ];
188  protected $mShowCancel = false;
189  protected $mCancelTarget;
190 
191  protected $mSubmitCallback;
193 
194  protected $mPre = '';
195  protected $mHeader = '';
196  protected $mFooter = '';
197  protected $mSectionHeaders = [];
198  protected $mSectionFooters = [];
199  protected $mPost = '';
200  protected $mId;
201  protected $mName;
202  protected $mTableId = '';
203 
204  protected $mSubmitID;
205  protected $mSubmitName;
206  protected $mSubmitText;
207  protected $mSubmitTooltip;
208 
209  protected $mFormIdentifier;
210  protected $mTitle;
211  protected $mMethod = 'post';
212  protected $mWasSubmitted = false;
213 
219  protected $mAction = false;
220 
226  protected $mAutocomplete = null;
227 
228  protected $mUseMultipart = false;
229  protected $mHiddenFields = [];
230  protected $mButtons = [];
231 
232  protected $mWrapperLegend = false;
233 
238  protected $mTokenSalt = '';
239 
247  protected $mSubSectionBeforeFields = true;
248 
254  protected $displayFormat = 'table';
255 
261  'table',
262  'div',
263  'raw',
264  'inline',
265  ];
266 
272  'vform',
273  'ooui',
274  ];
275 
283  public static function factory( $displayFormat/*, $arguments...*/ ) {
284  $arguments = func_get_args();
285  array_shift( $arguments );
286 
287  switch ( $displayFormat ) {
288  case 'vform':
289  return ObjectFactory::constructClassInstance( VFormHTMLForm::class, $arguments );
290  case 'ooui':
291  return ObjectFactory::constructClassInstance( OOUIHTMLForm::class, $arguments );
292  default:
294  $form = ObjectFactory::constructClassInstance( self::class, $arguments );
295  $form->setDisplayFormat( $displayFormat );
296  return $form;
297  }
298  }
299 
308  public function __construct( $descriptor, /*IContextSource*/ $context = null,
309  $messagePrefix = ''
310  ) {
311  if ( $context instanceof IContextSource ) {
312  $this->setContext( $context );
313  $this->mTitle = false; // We don't need them to set a title
314  $this->mMessagePrefix = $messagePrefix;
315  } elseif ( $context === null && $messagePrefix !== '' ) {
316  $this->mMessagePrefix = $messagePrefix;
317  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
318  // B/C since 1.18
319  // it's actually $messagePrefix
320  $this->mMessagePrefix = $context;
321  }
322 
323  // Evil hack for mobile :(
324  if (
325  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
326  && $this->displayFormat === 'table'
327  ) {
328  $this->displayFormat = 'div';
329  }
330 
331  // Expand out into a tree.
332  $loadedDescriptor = [];
333  $this->mFlatFields = [];
334 
335  foreach ( $descriptor as $fieldname => $info ) {
336  $section = isset( $info['section'] )
337  ? $info['section']
338  : '';
339 
340  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
341  $this->mUseMultipart = true;
342  }
343 
344  $field = static::loadInputFromParameters( $fieldname, $info, $this );
345 
346  $setSection =& $loadedDescriptor;
347  if ( $section ) {
348  $sectionParts = explode( '/', $section );
349 
350  while ( count( $sectionParts ) ) {
351  $newName = array_shift( $sectionParts );
352 
353  if ( !isset( $setSection[$newName] ) ) {
354  $setSection[$newName] = [];
355  }
356 
357  $setSection =& $setSection[$newName];
358  }
359  }
360 
361  $setSection[$fieldname] = $field;
362  $this->mFlatFields[$fieldname] = $field;
363  }
364 
365  $this->mFieldTree = $loadedDescriptor;
366  }
367 
372  public function hasField( $fieldname ) {
373  return isset( $this->mFlatFields[$fieldname] );
374  }
375 
381  public function getField( $fieldname ) {
382  if ( !$this->hasField( $fieldname ) ) {
383  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
384  }
385  return $this->mFlatFields[$fieldname];
386  }
387 
398  public function setDisplayFormat( $format ) {
399  if (
400  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
401  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
402  ) {
403  throw new MWException( 'Cannot change display format after creation, ' .
404  'use HTMLForm::factory() instead' );
405  }
406 
407  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
408  throw new MWException( 'Display format must be one of ' .
409  print_r(
410  array_merge(
411  $this->availableDisplayFormats,
412  $this->availableSubclassDisplayFormats
413  ),
414  true
415  ) );
416  }
417 
418  // Evil hack for mobile :(
419  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
420  $format = 'div';
421  }
422 
423  $this->displayFormat = $format;
424 
425  return $this;
426  }
427 
433  public function getDisplayFormat() {
434  return $this->displayFormat;
435  }
436 
453  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
454  if ( isset( $descriptor['class'] ) ) {
455  $class = $descriptor['class'];
456  } elseif ( isset( $descriptor['type'] ) ) {
457  $class = static::$typeMappings[$descriptor['type']];
458  $descriptor['class'] = $class;
459  } else {
460  $class = null;
461  }
462 
463  if ( !$class ) {
464  throw new MWException( "Descriptor with no class for $fieldname: "
465  . print_r( $descriptor, true ) );
466  }
467 
468  return $class;
469  }
470 
481  public static function loadInputFromParameters( $fieldname, $descriptor,
482  HTMLForm $parent = null
483  ) {
484  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
485 
486  $descriptor['fieldname'] = $fieldname;
487  if ( $parent ) {
488  $descriptor['parent'] = $parent;
489  }
490 
491  # @todo This will throw a fatal error whenever someone try to use
492  # 'class' to feed a CSS class instead of 'cssclass'. Would be
493  # great to avoid the fatal error and show a nice error.
494  return new $class( $descriptor );
495  }
496 
506  public function prepareForm() {
507  # Check if we have the info we need
508  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
509  throw new MWException( 'You must call setTitle() on an HTMLForm' );
510  }
511 
512  # Load data from the request.
513  if (
514  $this->mFormIdentifier === null ||
515  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
516  ) {
517  $this->loadData();
518  } else {
519  $this->mFieldData = [];
520  }
521 
522  return $this;
523  }
524 
529  public function tryAuthorizedSubmit() {
530  $result = false;
531 
532  $identOkay = false;
533  if ( $this->mFormIdentifier === null ) {
534  $identOkay = true;
535  } else {
536  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
537  }
538 
539  $tokenOkay = false;
540  if ( $this->getMethod() !== 'post' ) {
541  $tokenOkay = true; // no session check needed
542  } elseif ( $this->getRequest()->wasPosted() ) {
543  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
544  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
545  // Session tokens for logged-out users have no security value.
546  // However, if the user gave one, check it in order to give a nice
547  // "session expired" error instead of "permission denied" or such.
548  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
549  } else {
550  $tokenOkay = true;
551  }
552  }
553 
554  if ( $tokenOkay && $identOkay ) {
555  $this->mWasSubmitted = true;
556  $result = $this->trySubmit();
557  }
558 
559  return $result;
560  }
561 
568  public function show() {
569  $this->prepareForm();
570 
571  $result = $this->tryAuthorizedSubmit();
572  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
573  return $result;
574  }
575 
576  $this->displayForm( $result );
577 
578  return false;
579  }
580 
586  public function showAlways() {
587  $this->prepareForm();
588 
589  $result = $this->tryAuthorizedSubmit();
590 
591  $this->displayForm( $result );
592 
593  return $result;
594  }
595 
607  public function trySubmit() {
608  $valid = true;
609  $hoistedErrors = Status::newGood();
610  if ( $this->mValidationErrorMessage ) {
611  foreach ( (array)$this->mValidationErrorMessage as $error ) {
612  call_user_func_array( [ $hoistedErrors, 'fatal' ], $error );
613  }
614  } else {
615  $hoistedErrors->fatal( 'htmlform-invalid-input' );
616  }
617 
618  $this->mWasSubmitted = true;
619 
620  # Check for cancelled submission
621  foreach ( $this->mFlatFields as $fieldname => $field ) {
622  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
623  continue;
624  }
625  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
626  $this->mWasSubmitted = false;
627  return false;
628  }
629  }
630 
631  # Check for validation
632  foreach ( $this->mFlatFields as $fieldname => $field ) {
633  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
634  continue;
635  }
636  if ( $field->isHidden( $this->mFieldData ) ) {
637  continue;
638  }
639  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
640  if ( $res !== true ) {
641  $valid = false;
642  if ( $res !== false && !$field->canDisplayErrors() ) {
643  if ( is_string( $res ) ) {
644  $hoistedErrors->fatal( 'rawmessage', $res );
645  } else {
646  $hoistedErrors->fatal( $res );
647  }
648  }
649  }
650  }
651 
652  if ( !$valid ) {
653  return $hoistedErrors;
654  }
655 
656  $callback = $this->mSubmitCallback;
657  if ( !is_callable( $callback ) ) {
658  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
659  'setSubmitCallback() to set one.' );
660  }
661 
662  $data = $this->filterDataForSubmit( $this->mFieldData );
663 
664  $res = call_user_func( $callback, $data, $this );
665  if ( $res === false ) {
666  $this->mWasSubmitted = false;
667  }
668 
669  return $res;
670  }
671 
683  public function wasSubmitted() {
684  return $this->mWasSubmitted;
685  }
686 
697  public function setSubmitCallback( $cb ) {
698  $this->mSubmitCallback = $cb;
699 
700  return $this;
701  }
702 
711  public function setValidationErrorMessage( $msg ) {
712  $this->mValidationErrorMessage = $msg;
713 
714  return $this;
715  }
716 
724  public function setIntro( $msg ) {
725  $this->setPreText( $msg );
726 
727  return $this;
728  }
729 
738  public function setPreText( $msg ) {
739  $this->mPre = $msg;
740 
741  return $this;
742  }
743 
751  public function addPreText( $msg ) {
752  $this->mPre .= $msg;
753 
754  return $this;
755  }
756 
765  public function addHeaderText( $msg, $section = null ) {
766  if ( $section === null ) {
767  $this->mHeader .= $msg;
768  } else {
769  if ( !isset( $this->mSectionHeaders[$section] ) ) {
770  $this->mSectionHeaders[$section] = '';
771  }
772  $this->mSectionHeaders[$section] .= $msg;
773  }
774 
775  return $this;
776  }
777 
787  public function setHeaderText( $msg, $section = null ) {
788  if ( $section === null ) {
789  $this->mHeader = $msg;
790  } else {
791  $this->mSectionHeaders[$section] = $msg;
792  }
793 
794  return $this;
795  }
796 
804  public function getHeaderText( $section = null ) {
805  if ( $section === null ) {
806  return $this->mHeader;
807  } else {
808  return isset( $this->mSectionHeaders[$section] ) ? $this->mSectionHeaders[$section] : '';
809  }
810  }
811 
820  public function addFooterText( $msg, $section = null ) {
821  if ( $section === null ) {
822  $this->mFooter .= $msg;
823  } else {
824  if ( !isset( $this->mSectionFooters[$section] ) ) {
825  $this->mSectionFooters[$section] = '';
826  }
827  $this->mSectionFooters[$section] .= $msg;
828  }
829 
830  return $this;
831  }
832 
842  public function setFooterText( $msg, $section = null ) {
843  if ( $section === null ) {
844  $this->mFooter = $msg;
845  } else {
846  $this->mSectionFooters[$section] = $msg;
847  }
848 
849  return $this;
850  }
851 
859  public function getFooterText( $section = null ) {
860  if ( $section === null ) {
861  return $this->mFooter;
862  } else {
863  return isset( $this->mSectionFooters[$section] ) ? $this->mSectionFooters[$section] : '';
864  }
865  }
866 
874  public function addPostText( $msg ) {
875  $this->mPost .= $msg;
876 
877  return $this;
878  }
879 
887  public function setPostText( $msg ) {
888  $this->mPost = $msg;
889 
890  return $this;
891  }
892 
902  public function addHiddenField( $name, $value, array $attribs = [] ) {
903  $attribs += [ 'name' => $name ];
904  $this->mHiddenFields[] = [ $value, $attribs ];
905 
906  return $this;
907  }
908 
919  public function addHiddenFields( array $fields ) {
920  foreach ( $fields as $name => $value ) {
921  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
922  }
923 
924  return $this;
925  }
926 
951  public function addButton( $data ) {
952  if ( !is_array( $data ) ) {
953  $args = func_get_args();
954  if ( count( $args ) < 2 || count( $args ) > 4 ) {
955  throw new InvalidArgumentException(
956  'Incorrect number of arguments for deprecated calling style'
957  );
958  }
959  $data = [
960  'name' => $args[0],
961  'value' => $args[1],
962  'id' => isset( $args[2] ) ? $args[2] : null,
963  'attribs' => isset( $args[3] ) ? $args[3] : null,
964  ];
965  } else {
966  if ( !isset( $data['name'] ) ) {
967  throw new InvalidArgumentException( 'A name is required' );
968  }
969  if ( !isset( $data['value'] ) ) {
970  throw new InvalidArgumentException( 'A value is required' );
971  }
972  }
973  $this->mButtons[] = $data + [
974  'id' => null,
975  'attribs' => null,
976  'flags' => null,
977  'framed' => true,
978  ];
979 
980  return $this;
981  }
982 
992  public function setTokenSalt( $salt ) {
993  $this->mTokenSalt = $salt;
994 
995  return $this;
996  }
997 
1010  public function displayForm( $submitResult ) {
1011  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1012  }
1013 
1021  public function getHTML( $submitResult ) {
1022  # For good measure (it is the default)
1023  $this->getOutput()->preventClickjacking();
1024  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1025  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1026 
1027  $html = ''
1028  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1029  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1030  . $this->getHeaderText()
1031  . $this->getBody()
1032  . $this->getHiddenFields()
1033  . $this->getButtons()
1034  . $this->getFooterText();
1035 
1036  $html = $this->wrapForm( $html );
1037 
1038  return '' . $this->mPre . $html . $this->mPost;
1039  }
1040 
1045  protected function getFormAttributes() {
1046  # Use multipart/form-data
1047  $encType = $this->mUseMultipart
1048  ? 'multipart/form-data'
1049  : 'application/x-www-form-urlencoded';
1050  # Attributes
1051  $attribs = [
1052  'class' => 'mw-htmlform',
1053  'action' => $this->getAction(),
1054  'method' => $this->getMethod(),
1055  'enctype' => $encType,
1056  ];
1057  if ( $this->mId ) {
1058  $attribs['id'] = $this->mId;
1059  }
1060  if ( is_string( $this->mAutocomplete ) ) {
1061  $attribs['autocomplete'] = $this->mAutocomplete;
1062  }
1063  if ( $this->mName ) {
1064  $attribs['name'] = $this->mName;
1065  }
1066  if ( $this->needsJSForHtml5FormValidation() ) {
1067  $attribs['novalidate'] = true;
1068  }
1069  return $attribs;
1070  }
1071 
1079  public function wrapForm( $html ) {
1080  # Include a <fieldset> wrapper for style, if requested.
1081  if ( $this->mWrapperLegend !== false ) {
1082  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1083  $html = Xml::fieldset( $legend, $html );
1084  }
1085 
1086  return Html::rawElement(
1087  'form',
1088  $this->getFormAttributes(),
1089  $html
1090  );
1091  }
1092 
1097  public function getHiddenFields() {
1098  $html = '';
1099  if ( $this->mFormIdentifier !== null ) {
1100  $html .= Html::hidden(
1101  'wpFormIdentifier',
1102  $this->mFormIdentifier
1103  ) . "\n";
1104  }
1105  if ( $this->getMethod() === 'post' ) {
1106  $html .= Html::hidden(
1107  'wpEditToken',
1108  $this->getUser()->getEditToken( $this->mTokenSalt ),
1109  [ 'id' => 'wpEditToken' ]
1110  ) . "\n";
1111  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1112  }
1113 
1114  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1115  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1116  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1117  }
1118 
1119  foreach ( $this->mHiddenFields as $data ) {
1120  list( $value, $attribs ) = $data;
1121  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1122  }
1123 
1124  return $html;
1125  }
1126 
1131  public function getButtons() {
1132  $buttons = '';
1133  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1134 
1135  if ( $this->mShowSubmit ) {
1136  $attribs = [];
1137 
1138  if ( isset( $this->mSubmitID ) ) {
1139  $attribs['id'] = $this->mSubmitID;
1140  }
1141 
1142  if ( isset( $this->mSubmitName ) ) {
1143  $attribs['name'] = $this->mSubmitName;
1144  }
1145 
1146  if ( isset( $this->mSubmitTooltip ) ) {
1147  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1148  }
1149 
1150  $attribs['class'] = [ 'mw-htmlform-submit' ];
1151 
1152  if ( $useMediaWikiUIEverywhere ) {
1153  foreach ( $this->mSubmitFlags as $flag ) {
1154  $attribs['class'][] = 'mw-ui-' . $flag;
1155  }
1156  $attribs['class'][] = 'mw-ui-button';
1157  }
1158 
1159  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1160  }
1161 
1162  if ( $this->mShowReset ) {
1163  $buttons .= Html::element(
1164  'input',
1165  [
1166  'type' => 'reset',
1167  'value' => $this->msg( 'htmlform-reset' )->text(),
1168  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1169  ]
1170  ) . "\n";
1171  }
1172 
1173  if ( $this->mShowCancel ) {
1174  $target = $this->mCancelTarget ?: Title::newMainPage();
1175  if ( $target instanceof Title ) {
1176  $target = $target->getLocalURL();
1177  }
1178  $buttons .= Html::element(
1179  'a',
1180  [
1181  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1182  'href' => $target,
1183  ],
1184  $this->msg( 'cancel' )->text()
1185  ) . "\n";
1186  }
1187 
1188  // IE<8 has bugs with <button>, so we'll need to avoid them.
1189  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1190 
1191  foreach ( $this->mButtons as $button ) {
1192  $attrs = [
1193  'type' => 'submit',
1194  'name' => $button['name'],
1195  'value' => $button['value']
1196  ];
1197 
1198  if ( isset( $button['label-message'] ) ) {
1199  $label = $this->getMessage( $button['label-message'] )->parse();
1200  } elseif ( isset( $button['label'] ) ) {
1201  $label = htmlspecialchars( $button['label'] );
1202  } elseif ( isset( $button['label-raw'] ) ) {
1203  $label = $button['label-raw'];
1204  } else {
1205  $label = htmlspecialchars( $button['value'] );
1206  }
1207 
1208  if ( $button['attribs'] ) {
1209  $attrs += $button['attribs'];
1210  }
1211 
1212  if ( isset( $button['id'] ) ) {
1213  $attrs['id'] = $button['id'];
1214  }
1215 
1216  if ( $useMediaWikiUIEverywhere ) {
1217  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1218  $attrs['class'][] = 'mw-ui-button';
1219  }
1220 
1221  if ( $isBadIE ) {
1222  $buttons .= Html::element( 'input', $attrs ) . "\n";
1223  } else {
1224  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1225  }
1226  }
1227 
1228  if ( !$buttons ) {
1229  return '';
1230  }
1231 
1232  return Html::rawElement( 'span',
1233  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1234  }
1235 
1240  public function getBody() {
1241  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1242  }
1243 
1253  public function getErrors( $errors ) {
1254  wfDeprecated( __METHOD__ );
1255  return $this->getErrorsOrWarnings( $errors, 'error' );
1256  }
1257 
1266  public function getErrorsOrWarnings( $elements, $elementsType ) {
1267  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1268  throw new DomainException( $elementsType . ' is not a valid type.' );
1269  }
1270  $elementstr = false;
1271  if ( $elements instanceof Status ) {
1272  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1273  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1274  if ( $status->isGood() ) {
1275  $elementstr = '';
1276  } else {
1277  $elementstr = $this->getOutput()->parse(
1278  $status->getWikiText()
1279  );
1280  }
1281  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1282  $elementstr = $this->formatErrors( $elements );
1283  } elseif ( $elementsType === 'error' ) {
1284  $elementstr = $elements;
1285  }
1286 
1287  return $elementstr
1288  ? Html::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1289  : '';
1290  }
1291 
1299  public function formatErrors( $errors ) {
1300  $errorstr = '';
1301 
1302  foreach ( $errors as $error ) {
1303  $errorstr .= Html::rawElement(
1304  'li',
1305  [],
1306  $this->getMessage( $error )->parse()
1307  );
1308  }
1309 
1310  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1311 
1312  return $errorstr;
1313  }
1314 
1322  public function setSubmitText( $t ) {
1323  $this->mSubmitText = $t;
1324 
1325  return $this;
1326  }
1327 
1334  public function setSubmitDestructive() {
1335  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1336 
1337  return $this;
1338  }
1339 
1348  public function setSubmitProgressive() {
1349  wfDeprecated( __METHOD__, '1.32' );
1350  $this->mSubmitFlags = [ 'progressive', 'primary' ];
1351 
1352  return $this;
1353  }
1354 
1363  public function setSubmitTextMsg( $msg ) {
1364  if ( !$msg instanceof Message ) {
1365  $msg = $this->msg( $msg );
1366  }
1367  $this->setSubmitText( $msg->text() );
1368 
1369  return $this;
1370  }
1371 
1376  public function getSubmitText() {
1377  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1378  }
1379 
1385  public function setSubmitName( $name ) {
1386  $this->mSubmitName = $name;
1387 
1388  return $this;
1389  }
1390 
1396  public function setSubmitTooltip( $name ) {
1397  $this->mSubmitTooltip = $name;
1398 
1399  return $this;
1400  }
1401 
1410  public function setSubmitID( $t ) {
1411  $this->mSubmitID = $t;
1412 
1413  return $this;
1414  }
1415 
1431  public function setFormIdentifier( $ident ) {
1432  $this->mFormIdentifier = $ident;
1433 
1434  return $this;
1435  }
1436 
1447  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1448  $this->mShowSubmit = !$suppressSubmit;
1449 
1450  return $this;
1451  }
1452 
1459  public function showCancel( $show = true ) {
1460  $this->mShowCancel = $show;
1461  return $this;
1462  }
1463 
1470  public function setCancelTarget( $target ) {
1471  $this->mCancelTarget = $target;
1472  return $this;
1473  }
1474 
1484  public function setTableId( $id ) {
1485  $this->mTableId = $id;
1486 
1487  return $this;
1488  }
1489 
1495  public function setId( $id ) {
1496  $this->mId = $id;
1497 
1498  return $this;
1499  }
1500 
1505  public function setName( $name ) {
1506  $this->mName = $name;
1507 
1508  return $this;
1509  }
1510 
1522  public function setWrapperLegend( $legend ) {
1523  $this->mWrapperLegend = $legend;
1524 
1525  return $this;
1526  }
1527 
1537  public function setWrapperLegendMsg( $msg ) {
1538  if ( !$msg instanceof Message ) {
1539  $msg = $this->msg( $msg );
1540  }
1541  $this->setWrapperLegend( $msg->text() );
1542 
1543  return $this;
1544  }
1545 
1555  public function setMessagePrefix( $p ) {
1556  $this->mMessagePrefix = $p;
1557 
1558  return $this;
1559  }
1560 
1568  public function setTitle( $t ) {
1569  $this->mTitle = $t;
1570 
1571  return $this;
1572  }
1573 
1578  public function getTitle() {
1579  return $this->mTitle === false
1580  ? $this->getContext()->getTitle()
1581  : $this->mTitle;
1582  }
1583 
1591  public function setMethod( $method = 'post' ) {
1592  $this->mMethod = strtolower( $method );
1593 
1594  return $this;
1595  }
1596 
1600  public function getMethod() {
1601  return $this->mMethod;
1602  }
1603 
1613  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1614  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1615  }
1616 
1633  public function displaySection( $fields,
1634  $sectionName = '',
1635  $fieldsetIDPrefix = '',
1636  &$hasUserVisibleFields = false
1637  ) {
1638  if ( $this->mFieldData === null ) {
1639  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1640  . 'You probably called displayForm() without calling prepareForm() first.' );
1641  }
1642 
1643  $displayFormat = $this->getDisplayFormat();
1644 
1645  $html = [];
1646  $subsectionHtml = '';
1647  $hasLabel = false;
1648 
1649  // Conveniently, PHP method names are case-insensitive.
1650  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1651  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1652 
1653  foreach ( $fields as $key => $value ) {
1654  if ( $value instanceof HTMLFormField ) {
1655  $v = array_key_exists( $key, $this->mFieldData )
1656  ? $this->mFieldData[$key]
1657  : $value->getDefault();
1658 
1659  $retval = $value->$getFieldHtmlMethod( $v );
1660 
1661  // check, if the form field should be added to
1662  // the output.
1663  if ( $value->hasVisibleOutput() ) {
1664  $html[] = $retval;
1665 
1666  $labelValue = trim( $value->getLabel() );
1667  if ( $labelValue !== '&#160;' && $labelValue !== '' ) {
1668  $hasLabel = true;
1669  }
1670 
1671  $hasUserVisibleFields = true;
1672  }
1673  } elseif ( is_array( $value ) ) {
1674  $subsectionHasVisibleFields = false;
1675  $section =
1676  $this->displaySection( $value,
1677  "mw-htmlform-$key",
1678  "$fieldsetIDPrefix$key-",
1679  $subsectionHasVisibleFields );
1680  $legend = null;
1681 
1682  if ( $subsectionHasVisibleFields === true ) {
1683  // Display the section with various niceties.
1684  $hasUserVisibleFields = true;
1685 
1686  $legend = $this->getLegend( $key );
1687 
1688  $section = $this->getHeaderText( $key ) .
1689  $section .
1690  $this->getFooterText( $key );
1691 
1692  $attributes = [];
1693  if ( $fieldsetIDPrefix ) {
1694  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1695  }
1696  $subsectionHtml .= $this->wrapFieldSetSection(
1697  $legend, $section, $attributes, $fields === $this->mFieldTree
1698  );
1699  } else {
1700  // Just return the inputs, nothing fancy.
1701  $subsectionHtml .= $section;
1702  }
1703  }
1704  }
1705 
1706  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1707 
1708  if ( $subsectionHtml ) {
1709  if ( $this->mSubSectionBeforeFields ) {
1710  return $subsectionHtml . "\n" . $html;
1711  } else {
1712  return $html . "\n" . $subsectionHtml;
1713  }
1714  } else {
1715  return $html;
1716  }
1717  }
1718 
1726  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1727  if ( !$fieldsHtml ) {
1728  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1729  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1730  return '';
1731  }
1732 
1733  $displayFormat = $this->getDisplayFormat();
1734  $html = implode( '', $fieldsHtml );
1735 
1736  if ( $displayFormat === 'raw' ) {
1737  return $html;
1738  }
1739 
1740  $classes = [];
1741 
1742  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1743  $classes[] = 'mw-htmlform-nolabel';
1744  }
1745 
1746  $attribs = [
1747  'class' => implode( ' ', $classes ),
1748  ];
1749 
1750  if ( $sectionName ) {
1751  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1752  }
1753 
1754  if ( $displayFormat === 'table' ) {
1755  return Html::rawElement( 'table',
1756  $attribs,
1757  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1758  } elseif ( $displayFormat === 'inline' ) {
1759  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1760  } else {
1761  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1762  }
1763  }
1764 
1768  public function loadData() {
1769  $fieldData = [];
1770 
1771  foreach ( $this->mFlatFields as $fieldname => $field ) {
1772  $request = $this->getRequest();
1773  if ( $field->skipLoadData( $request ) ) {
1774  continue;
1775  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1776  $fieldData[$fieldname] = $field->getDefault();
1777  } else {
1778  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1779  }
1780  }
1781 
1782  # Filter data.
1783  foreach ( $fieldData as $name => &$value ) {
1784  $field = $this->mFlatFields[$name];
1785  $value = $field->filter( $value, $this->mFlatFields );
1786  }
1787 
1788  $this->mFieldData = $fieldData;
1789  }
1790 
1798  public function suppressReset( $suppressReset = true ) {
1799  $this->mShowReset = !$suppressReset;
1800 
1801  return $this;
1802  }
1803 
1813  public function filterDataForSubmit( $data ) {
1814  return $data;
1815  }
1816 
1825  public function getLegend( $key ) {
1826  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1827  }
1828 
1839  public function setAction( $action ) {
1840  $this->mAction = $action;
1841 
1842  return $this;
1843  }
1844 
1852  public function getAction() {
1853  // If an action is alredy provided, return it
1854  if ( $this->mAction !== false ) {
1855  return $this->mAction;
1856  }
1857 
1858  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1859  // Check whether we are in GET mode and the ArticlePath contains a "?"
1860  // meaning that getLocalURL() would return something like "index.php?title=...".
1861  // As browser remove the query string before submitting GET forms,
1862  // it means that the title would be lost. In such case use wfScript() instead
1863  // and put title in an hidden field (see getHiddenFields()).
1864  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1865  return wfScript();
1866  }
1867 
1868  return $this->getTitle()->getLocalURL();
1869  }
1870 
1881  public function setAutocomplete( $autocomplete ) {
1882  $this->mAutocomplete = $autocomplete;
1883 
1884  return $this;
1885  }
1886 
1893  protected function getMessage( $value ) {
1894  return Message::newFromSpecifier( $value )->setContext( $this );
1895  }
1896 
1906  public function needsJSForHtml5FormValidation() {
1907  foreach ( $this->mFlatFields as $fieldname => $field ) {
1908  if ( $field->needsJSForHtml5FormValidation() ) {
1909  return true;
1910  }
1911  }
1912  return false;
1913  }
1914 }
HTMLFormField[] $mFlatFields
Definition: HTMLForm.php:182
getFooterText($section=null)
Get footer text.
Definition: HTMLForm.php:859
setContext(IContextSource $context)
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:586
string null $mAutocomplete
Form attribute autocomplete.
Definition: HTMLForm.php:226
needsJSForHtml5FormValidation()
Whether this form, with its current fields, requires the user agent to have JavaScript enabled for th...
Definition: HTMLForm.php:1906
setName($name)
Definition: HTMLForm.php:1505
setTokenSalt($salt)
Set the salt for the edit token.
Definition: HTMLForm.php:992
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:2019
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
the array() calling protocol came about after MediaWiki 1.4rc1.
static $typeMappings
Definition: HTMLForm.php:135
getHTML($submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1021
getErrors($errors)
Format and display an error message stack.
Definition: HTMLForm.php:1253
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2610
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
prepareForm()
Prepare form for submission.
Definition: HTMLForm.php:506
hasField($fieldname)
Definition: HTMLForm.php:372
addHiddenField($name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:902
$mWasSubmitted
Definition: HTMLForm.php:212
setPreText($msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:738
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:586
$mWrapperLegend
Definition: HTMLForm.php:232
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getAction()
Get the value for the action attribute of the form.
Definition: HTMLForm.php:1852
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:433
setId($id)
Definition: HTMLForm.php:1495
setAutocomplete($autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1881
setMethod($method= 'post')
Set the method used to submit the form.
Definition: HTMLForm.php:1591
$mUseMultipart
Definition: HTMLForm.php:228
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
setSubmitName($name)
Definition: HTMLForm.php:1385
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher...
Definition: HTMLForm.php:607
showCancel($show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1459
setSubmitTooltip($name)
Definition: HTMLForm.php:1396
__construct($descriptor, $context=null, $messagePrefix= '')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:308
static hidden($name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:790
static factory($displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:283
$mHiddenFields
Definition: HTMLForm.php:229
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:1893
addHeaderText($msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:765
setWrapperLegendMsg($msg)
Prompt the whole form to be wrapped in a "
", with this message as its "" element...
Definition: HTMLForm.php:1537
$value
setSubmitCallback($cb)
Set a callback to a function to do something with the form once it's been successfully validated...
Definition: HTMLForm.php:697
setCancelTarget($target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1470
setIntro($msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:724
static tooltipAndAccesskeyAttribs($name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2135
$mSubmitCallback
Definition: HTMLForm.php:191
setSubmitID($t)
Set the id for the submit button.
Definition: HTMLForm.php:1410
$mSubmitTooltip
Definition: HTMLForm.php:207
IContextSource $context
static submitButton($value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:460
setDisplayFormat($format)
Set format in which to display the form.
Definition: HTMLForm.php:398
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:260
setTitle($t)
Set the title for form submission.
Definition: HTMLForm.php:1568
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn't exist locally, this hook is called to give extensions an opportunity to auto-create it.If the auto-creation is successful, return false.$name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Array with elements of the form"language:title"in the order that they will be output.&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:2017
setValidationErrorMessage($msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:711
getHiddenFields()
Get the hidden fields that should go inside the form.
Definition: HTMLForm.php:1097
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:238
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:919
if($line===false) $args
Definition: cdb.php:64
bool string $mAction
Form action URL.
Definition: HTMLForm.php:219
$mValidationErrorMessage
Definition: HTMLForm.php:192
setSubmitProgressive()
Identify that the submit button in the form has a progressive action.
Definition: HTMLForm.php:1348
addPostText($msg)
Add text to the end of the display.
Definition: HTMLForm.php:874
static fieldset($legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:610
setSubmitText($t)
Set the text for the submit button.
Definition: HTMLForm.php:1322
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:254
show()
The here's-one-I-made-earlier option: do the submission if posted, or display the form with or withou...
Definition: HTMLForm.php:568
static $mFieldData
Definition: HTMLForm.php:137
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1334
setPostText($msg)
Set text at the end of the display.
Definition: HTMLForm.php:887
$res
Definition: database.txt:21
getLegend($key)
Get a string to go in the "" of a section fieldset.
Definition: HTMLForm.php:1825
getTitle()
Get the title.
Definition: HTMLForm.php:1578
getHeaderText($section=null)
Get header text.
Definition: HTMLForm.php:804
getField($fieldname)
Definition: HTMLForm.php:381
getContext()
Get the base IContextSource object.
getFormAttributes()
Get HTML attributes for the
tag.
Definition: HTMLForm.php:1045
setTableId($id)
Set the id of the \ or outermost \ element.
Definition: HTMLForm.php:1484
getErrorsOrWarnings($elements, $elementsType)
Returns a formatted list of errors or warnings from the given elements.
Definition: HTMLForm.php:1266
setSubmitTextMsg($msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1363
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:2019
setWrapperLegend($legend)
Prompt the whole form to be wrapped in a "
", with this text as its "" element...
Definition: HTMLForm.php:1522
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields' HTML, merging it and wrapping.
Definition: HTMLForm.php:1726
array $availableSubclassDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:271
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:81
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
formatErrors($errors)
Format a stack of error messages into a single HTML string.
Definition: HTMLForm.php:1299
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1376
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
filterDataForSubmit($data)
Overload this if you want to apply special filtration routines to the form as a whole, after it's submitted but before it's processed.
Definition: HTMLForm.php:1813
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3038
static loadInputFromParameters($fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: HTMLForm.php:481
setHeaderText($msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:787
static getClassFromDescriptor($fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:453
$mCancelTarget
Definition: HTMLForm.php:189
setFooterText($msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:842
displaySection($fields, $sectionName= '', $fieldsetIDPrefix= '', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1633
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:683
$mFormIdentifier
Definition: HTMLForm.php:209
suppressDefaultSubmit($suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1447
displayForm($submitResult)
Display the form (sending to the context's OutputPage object), with an appropriate error message or s...
Definition: HTMLForm.php:1010
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
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:1243
$mSectionFooters
Definition: HTMLForm.php:198
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
loadData()
Construct the form fields from the Descriptor array.
Definition: HTMLForm.php:1768
wrapForm($html)
Wrap the form innards in an actual "" element.
Definition: HTMLForm.php:1079
addPreText($msg)
Add HTML to introductory message.
Definition: HTMLForm.php:751
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:529
setFormIdentifier($ident)
Set an internal identifier for this form.
Definition: HTMLForm.php:1431
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
addButton($data)
Add a button to the form.
Definition: HTMLForm.php:951
msg($key)
Get a Message object with context set Parameters are the same as wfMessage()
$mSectionHeaders
Definition: HTMLForm.php:197
Status::newGood()`to allow deletion, and then`return false`from the hook function.Ensure you consume the 'ChangeTagAfterDelete'hook to carry out custom deletion actions.$tag:name of the tag $user:user initiating the action &$status:Status object.See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use.&$tags:list of all active tags.Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function.Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change.&$allowedTags:List of all the tags the user is allowed to add.Any tags the user wants to add($addTags) that are not in this array will cause it to fail.You may add or remove tags to this array as required.$addTags:List of tags user intends to add.$user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed.$performer:The User who will perform the change $user:The User whose groups will be changed &$add:The groups that will be added &$remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation.$collationName:Name of the collation in question &$collationObject:Null.Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user's email has been confirmed successfully.$user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object.Called by Content::getParserOutput after parsing has finished.Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML).$content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput.May be used to override the normal model-specific rendering of page content.$content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering.To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state.$generateHtml:boolean, indicating whether full HTML should be generated.If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object.&$output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title.May be used to assign a different model for that title.$title:the Title in question &$model:the model name.Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers.Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core.$modeName:the requested content model name &$handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page.This is especially useful to prevent some content models to be used in some special location.$contentModel:ID of the content model in question $title:the Title in question.&$ok:Output parameter, whether it is OK to use $contentModel on $title.Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run &$pager:Pager object for contributions &$queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions &$data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title &$tools:Array of tool links $specialPage:SpecialPage instance for context and services.Can be either SpecialContributions or DeletedContributionsPage.Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested.Handler functions that modify $result should generally return false to disable further attempts at conversion.$content:The Content object to be converted.$toModel:The ID of the content model to convert to.$lossy:boolean indicating whether lossy conversion is allowed.&$result:Output parameter, in case the handler function wants to provide a converted Content object.Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources.This affects all directives except for the script directive.If you want to add a script source, see ContentSecurityPolicyScriptSource hook.&$defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives.Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs.&$directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources.Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add.&$scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g.for a special namespace, etc.$article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery &$data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished.Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions &$ret:the HTML line $row:the DB row for this line &$classes:the classes to add to the surrounding< li > &$attribs:associative array of other HTML attributes for the< li > element.Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about.This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process.For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion.&where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table.$db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function.$differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable's value is null.This hook can be used to inject content into said class member variable.$differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the"mark as patrolled"link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink".$differenceEngine:DifferenceEngine object &$markAsPatrolledLink:The"mark as patrolled"link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter.For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions.&$rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision's author, whether the revision was marked as a minor edit or not, etc.$differenceEngine:DifferenceEngine object &$newHeader:The string containing the various#mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1287
setMessagePrefix($p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1555
addFooterText($msg, $section=null)
Add footer text, inside the form.
Definition: HTMLForm.php:820
$mMessagePrefix
Definition: HTMLForm.php:179
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1240
suppressReset($suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1798
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1131
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
Definition: hooks.txt:244
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g.with the RejectParserCacheValue hook) because MediaWiki won't do it for you.&$defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2636
wrapFieldSetSection($legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1613
$mSubSectionBeforeFields
If true, sections that contain both fields and subsections will render their subsections before their...
Definition: HTMLForm.php:247
setAction($action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1839
static newFromSpecifier($value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:414