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,
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 
185  protected $mFieldTree;
186  protected $mShowReset = false;
187  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;
244  protected $mHiddenFields = [];
245  protected $mButtons = [];
246 
247  protected $mWrapperLegend = false;
248  protected $mWrapperAttributes = [];
249 
254  protected $mTokenSalt = '';
255 
263  protected $mSubSectionBeforeFields = true;
264 
270  protected $displayFormat = 'table';
271 
277  'table',
278  'div',
279  'raw',
280  'inline',
281  ];
282 
288  'vform',
289  'ooui',
290  ];
291 
299  public static function factory( $displayFormat/*, $arguments...*/ ) {
300  $arguments = func_get_args();
301  array_shift( $arguments );
302 
303  switch ( $displayFormat ) {
304  case 'vform':
305  return new VFormHTMLForm( ...$arguments );
306  case 'ooui':
307  return new OOUIHTMLForm( ...$arguments );
308  default:
309  $form = new self( ...$arguments );
310  $form->setDisplayFormat( $displayFormat );
311  return $form;
312  }
313  }
314 
323  public function __construct( $descriptor, /*IContextSource*/ $context = null,
324  $messagePrefix = ''
325  ) {
326  if ( $context instanceof IContextSource ) {
327  $this->setContext( $context );
328  $this->mTitle = false; // We don't need them to set a title
329  $this->mMessagePrefix = $messagePrefix;
330  } elseif ( $context === null && $messagePrefix !== '' ) {
331  $this->mMessagePrefix = $messagePrefix;
332  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
333  // B/C since 1.18
334  // it's actually $messagePrefix
335  $this->mMessagePrefix = $context;
336  }
337 
338  // Evil hack for mobile :(
339  if (
340  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
341  && $this->displayFormat === 'table'
342  ) {
343  $this->displayFormat = 'div';
344  }
345 
346  // Expand out into a tree.
347  $loadedDescriptor = [];
348  $this->mFlatFields = [];
349 
350  foreach ( $descriptor as $fieldname => $info ) {
351  $section = $info['section'] ?? '';
352 
353  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
354  $this->mUseMultipart = true;
355  }
356 
357  $field = static::loadInputFromParameters( $fieldname, $info, $this );
358 
359  $setSection =& $loadedDescriptor;
360  if ( $section ) {
361  foreach ( explode( '/', $section ) as $newName ) {
362  if ( !isset( $setSection[$newName] ) ) {
363  $setSection[$newName] = [];
364  }
365 
366  $setSection =& $setSection[$newName];
367  }
368  }
369 
370  $setSection[$fieldname] = $field;
371  $this->mFlatFields[$fieldname] = $field;
372  }
373 
374  $this->mFieldTree = $loadedDescriptor;
375  }
376 
381  public function hasField( $fieldname ) {
382  return isset( $this->mFlatFields[$fieldname] );
383  }
384 
390  public function getField( $fieldname ) {
391  if ( !$this->hasField( $fieldname ) ) {
392  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
393  }
394  return $this->mFlatFields[$fieldname];
395  }
396 
407  public function setDisplayFormat( $format ) {
408  if (
409  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
410  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
411  ) {
412  throw new MWException( 'Cannot change display format after creation, ' .
413  'use HTMLForm::factory() instead' );
414  }
415 
416  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
417  throw new MWException( 'Display format must be one of ' .
418  print_r(
419  array_merge(
420  $this->availableDisplayFormats,
421  $this->availableSubclassDisplayFormats
422  ),
423  true
424  ) );
425  }
426 
427  // Evil hack for mobile :(
428  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
429  $format = 'div';
430  }
431 
432  $this->displayFormat = $format;
433 
434  return $this;
435  }
436 
442  public function getDisplayFormat() {
443  return $this->displayFormat;
444  }
445 
462  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
463  if ( isset( $descriptor['class'] ) ) {
464  $class = $descriptor['class'];
465  } elseif ( isset( $descriptor['type'] ) ) {
466  $class = static::$typeMappings[$descriptor['type']];
467  $descriptor['class'] = $class;
468  } else {
469  $class = null;
470  }
471 
472  if ( !$class ) {
473  throw new MWException( "Descriptor with no class for $fieldname: "
474  . print_r( $descriptor, true ) );
475  }
476 
477  return $class;
478  }
479 
490  public static function loadInputFromParameters( $fieldname, $descriptor,
492  ) {
493  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
494 
495  $descriptor['fieldname'] = $fieldname;
496  if ( $parent ) {
497  $descriptor['parent'] = $parent;
498  }
499 
500  # @todo This will throw a fatal error whenever someone try to use
501  # 'class' to feed a CSS class instead of 'cssclass'. Would be
502  # great to avoid the fatal error and show a nice error.
503  return new $class( $descriptor );
504  }
505 
515  public function prepareForm() {
516  # Check if we have the info we need
517  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
518  throw new MWException( 'You must call setTitle() on an HTMLForm' );
519  }
520 
521  # Load data from the request.
522  if (
523  $this->mFormIdentifier === null ||
524  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
525  ) {
526  $this->loadData();
527  } else {
528  $this->mFieldData = [];
529  }
530 
531  return $this;
532  }
533 
538  public function tryAuthorizedSubmit() {
539  $result = false;
540 
541  if ( $this->mFormIdentifier === null ) {
542  $identOkay = true;
543  } else {
544  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
545  }
546 
547  $tokenOkay = false;
548  if ( $this->getMethod() !== 'post' ) {
549  $tokenOkay = true; // no session check needed
550  } elseif ( $this->getRequest()->wasPosted() ) {
551  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
552  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
553  // Session tokens for logged-out users have no security value.
554  // However, if the user gave one, check it in order to give a nice
555  // "session expired" error instead of "permission denied" or such.
556  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
557  } else {
558  $tokenOkay = true;
559  }
560  }
561 
562  if ( $tokenOkay && $identOkay ) {
563  $this->mWasSubmitted = true;
564  $result = $this->trySubmit();
565  }
566 
567  return $result;
568  }
569 
576  public function show() {
577  $this->prepareForm();
578 
579  $result = $this->tryAuthorizedSubmit();
580  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
581  return $result;
582  }
583 
584  $this->displayForm( $result );
585 
586  return false;
587  }
588 
594  public function showAlways() {
595  $this->prepareForm();
596 
597  $result = $this->tryAuthorizedSubmit();
598 
599  $this->displayForm( $result );
600 
601  return $result;
602  }
603 
615  public function trySubmit() {
616  $valid = true;
617  $hoistedErrors = Status::newGood();
618  if ( $this->mValidationErrorMessage ) {
619  foreach ( $this->mValidationErrorMessage as $error ) {
620  $hoistedErrors->fatal( ...$error );
621  }
622  } else {
623  $hoistedErrors->fatal( 'htmlform-invalid-input' );
624  }
625 
626  $this->mWasSubmitted = true;
627 
628  # Check for cancelled submission
629  foreach ( $this->mFlatFields as $fieldname => $field ) {
630  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
631  continue;
632  }
633  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
634  $this->mWasSubmitted = false;
635  return false;
636  }
637  }
638 
639  # Check for validation
640  foreach ( $this->mFlatFields as $fieldname => $field ) {
641  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
642  continue;
643  }
644  if ( $field->isHidden( $this->mFieldData ) ) {
645  continue;
646  }
647  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
648  if ( $res !== true ) {
649  $valid = false;
650  if ( $res !== false && !$field->canDisplayErrors() ) {
651  if ( is_string( $res ) ) {
652  $hoistedErrors->fatal( 'rawmessage', $res );
653  } else {
654  $hoistedErrors->fatal( $res );
655  }
656  }
657  }
658  }
659 
660  if ( !$valid ) {
661  return $hoistedErrors;
662  }
663 
664  $callback = $this->mSubmitCallback;
665  if ( !is_callable( $callback ) ) {
666  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
667  'setSubmitCallback() to set one.' );
668  }
669 
670  $data = $this->filterDataForSubmit( $this->mFieldData );
671 
672  $res = call_user_func( $callback, $data, $this );
673  if ( $res === false ) {
674  $this->mWasSubmitted = false;
675  }
676 
677  return $res;
678  }
679 
691  public function wasSubmitted() {
692  return $this->mWasSubmitted;
693  }
694 
705  public function setSubmitCallback( $cb ) {
706  $this->mSubmitCallback = $cb;
707 
708  return $this;
709  }
710 
719  public function setValidationErrorMessage( $msg ) {
720  $this->mValidationErrorMessage = $msg;
721 
722  return $this;
723  }
724 
732  public function setIntro( $msg ) {
733  $this->setPreText( $msg );
734 
735  return $this;
736  }
737 
746  public function setPreText( $msg ) {
747  $this->mPre = $msg;
748 
749  return $this;
750  }
751 
759  public function addPreText( $msg ) {
760  $this->mPre .= $msg;
761 
762  return $this;
763  }
764 
772  public function getPreText() {
773  return $this->mPre;
774  }
775 
784  public function addHeaderText( $msg, $section = null ) {
785  if ( $section === null ) {
786  $this->mHeader .= $msg;
787  } else {
788  if ( !isset( $this->mSectionHeaders[$section] ) ) {
789  $this->mSectionHeaders[$section] = '';
790  }
791  $this->mSectionHeaders[$section] .= $msg;
792  }
793 
794  return $this;
795  }
796 
806  public function setHeaderText( $msg, $section = null ) {
807  if ( $section === null ) {
808  $this->mHeader = $msg;
809  } else {
810  $this->mSectionHeaders[$section] = $msg;
811  }
812 
813  return $this;
814  }
815 
823  public function getHeaderText( $section = null ) {
824  if ( $section === null ) {
825  return $this->mHeader;
826  } else {
827  return $this->mSectionHeaders[$section] ?? '';
828  }
829  }
830 
839  public function addFooterText( $msg, $section = null ) {
840  if ( $section === null ) {
841  $this->mFooter .= $msg;
842  } else {
843  if ( !isset( $this->mSectionFooters[$section] ) ) {
844  $this->mSectionFooters[$section] = '';
845  }
846  $this->mSectionFooters[$section] .= $msg;
847  }
848 
849  return $this;
850  }
851 
861  public function setFooterText( $msg, $section = null ) {
862  if ( $section === null ) {
863  $this->mFooter = $msg;
864  } else {
865  $this->mSectionFooters[$section] = $msg;
866  }
867 
868  return $this;
869  }
870 
878  public function getFooterText( $section = null ) {
879  if ( $section === null ) {
880  return $this->mFooter;
881  } else {
882  return $this->mSectionFooters[$section] ?? '';
883  }
884  }
885 
893  public function addPostText( $msg ) {
894  $this->mPost .= $msg;
895 
896  return $this;
897  }
898 
906  public function setPostText( $msg ) {
907  $this->mPost = $msg;
908 
909  return $this;
910  }
911 
921  public function addHiddenField( $name, $value, array $attribs = [] ) {
922  $attribs += [ 'name' => $name ];
923  $this->mHiddenFields[] = [ $value, $attribs ];
924 
925  return $this;
926  }
927 
938  public function addHiddenFields( array $fields ) {
939  foreach ( $fields as $name => $value ) {
940  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
941  }
942 
943  return $this;
944  }
945 
970  public function addButton( $data ) {
971  if ( !is_array( $data ) ) {
972  $args = func_get_args();
973  if ( count( $args ) < 2 || count( $args ) > 4 ) {
974  throw new InvalidArgumentException(
975  'Incorrect number of arguments for deprecated calling style'
976  );
977  }
978  $data = [
979  'name' => $args[0],
980  'value' => $args[1],
981  'id' => $args[2] ?? null,
982  'attribs' => $args[3] ?? null,
983  ];
984  } else {
985  if ( !isset( $data['name'] ) ) {
986  throw new InvalidArgumentException( 'A name is required' );
987  }
988  if ( !isset( $data['value'] ) ) {
989  throw new InvalidArgumentException( 'A value is required' );
990  }
991  }
992  $this->mButtons[] = $data + [
993  'id' => null,
994  'attribs' => null,
995  'flags' => null,
996  'framed' => true,
997  ];
998 
999  return $this;
1000  }
1001 
1011  public function setTokenSalt( $salt ) {
1012  $this->mTokenSalt = $salt;
1013 
1014  return $this;
1015  }
1016 
1029  public function displayForm( $submitResult ) {
1030  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1031  }
1032 
1041  public function getHTML( $submitResult ) {
1042  # For good measure (it is the default)
1043  $this->getOutput()->preventClickjacking();
1044  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1045  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1046 
1047  $html = ''
1048  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1049  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1050  . $this->getHeaderText()
1051  . $this->getBody()
1052  . $this->getHiddenFields()
1053  . $this->getButtons()
1054  . $this->getFooterText();
1055 
1056  $html = $this->wrapForm( $html );
1057 
1058  return '' . $this->mPre . $html . $this->mPost;
1059  }
1060 
1068  public function setCollapsibleOptions( $collapsedByDefault = false ) {
1069  $this->mCollapsible = true;
1070  $this->mCollapsed = $collapsedByDefault;
1071  return $this;
1072  }
1073 
1078  protected function getFormAttributes() {
1079  # Use multipart/form-data
1080  $encType = $this->mUseMultipart
1081  ? 'multipart/form-data'
1082  : 'application/x-www-form-urlencoded';
1083  # Attributes
1084  $attribs = [
1085  'class' => 'mw-htmlform',
1086  'action' => $this->getAction(),
1087  'method' => $this->getMethod(),
1088  'enctype' => $encType,
1089  ];
1090  if ( $this->mId ) {
1091  $attribs['id'] = $this->mId;
1092  }
1093  if ( is_string( $this->mAutocomplete ) ) {
1094  $attribs['autocomplete'] = $this->mAutocomplete;
1095  }
1096  if ( $this->mName ) {
1097  $attribs['name'] = $this->mName;
1098  }
1099  if ( $this->needsJSForHtml5FormValidation() ) {
1100  $attribs['novalidate'] = true;
1101  }
1102  return $attribs;
1103  }
1104 
1112  public function wrapForm( $html ) {
1113  # Include a <fieldset> wrapper for style, if requested.
1114  if ( $this->mWrapperLegend !== false ) {
1115  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1116  $html = Xml::fieldset( $legend, $html, $this->mWrapperAttributes );
1117  }
1118 
1119  return Html::rawElement(
1120  'form',
1121  $this->getFormAttributes(),
1122  $html
1123  );
1124  }
1125 
1130  public function getHiddenFields() {
1131  $html = '';
1132  if ( $this->mFormIdentifier !== null ) {
1133  $html .= Html::hidden(
1134  'wpFormIdentifier',
1135  $this->mFormIdentifier
1136  ) . "\n";
1137  }
1138  if ( $this->getMethod() === 'post' ) {
1139  $html .= Html::hidden(
1140  'wpEditToken',
1141  $this->getUser()->getEditToken( $this->mTokenSalt ),
1142  [ 'id' => 'wpEditToken' ]
1143  ) . "\n";
1144  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1145  }
1146 
1147  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1148  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1149  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1150  }
1151 
1152  foreach ( $this->mHiddenFields as $data ) {
1153  list( $value, $attribs ) = $data;
1154  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1155  }
1156 
1157  return $html;
1158  }
1159 
1164  public function getButtons() {
1165  $buttons = '';
1166  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1167 
1168  if ( $this->mShowSubmit ) {
1169  $attribs = [];
1170 
1171  if ( isset( $this->mSubmitID ) ) {
1172  $attribs['id'] = $this->mSubmitID;
1173  }
1174 
1175  if ( isset( $this->mSubmitName ) ) {
1176  $attribs['name'] = $this->mSubmitName;
1177  }
1178 
1179  if ( isset( $this->mSubmitTooltip ) ) {
1180  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1181  }
1182 
1183  $attribs['class'] = [ 'mw-htmlform-submit' ];
1184 
1185  if ( $useMediaWikiUIEverywhere ) {
1186  foreach ( $this->mSubmitFlags as $flag ) {
1187  $attribs['class'][] = 'mw-ui-' . $flag;
1188  }
1189  $attribs['class'][] = 'mw-ui-button';
1190  }
1191 
1192  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1193  }
1194 
1195  if ( $this->mShowReset ) {
1196  $buttons .= Html::element(
1197  'input',
1198  [
1199  'type' => 'reset',
1200  'value' => $this->msg( 'htmlform-reset' )->text(),
1201  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1202  ]
1203  ) . "\n";
1204  }
1205 
1206  if ( $this->mShowCancel ) {
1207  $target = $this->mCancelTarget ?: Title::newMainPage();
1208  if ( $target instanceof Title ) {
1209  $target = $target->getLocalURL();
1210  }
1211  $buttons .= Html::element(
1212  'a',
1213  [
1214  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1215  'href' => $target,
1216  ],
1217  $this->msg( 'cancel' )->text()
1218  ) . "\n";
1219  }
1220 
1221  // IE<8 has bugs with <button>, so we'll need to avoid them.
1222  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1223 
1224  foreach ( $this->mButtons as $button ) {
1225  $attrs = [
1226  'type' => 'submit',
1227  'name' => $button['name'],
1228  'value' => $button['value']
1229  ];
1230 
1231  if ( isset( $button['label-message'] ) ) {
1232  $label = $this->getMessage( $button['label-message'] )->parse();
1233  } elseif ( isset( $button['label'] ) ) {
1234  $label = htmlspecialchars( $button['label'] );
1235  } elseif ( isset( $button['label-raw'] ) ) {
1236  $label = $button['label-raw'];
1237  } else {
1238  $label = htmlspecialchars( $button['value'] );
1239  }
1240 
1241  if ( $button['attribs'] ) {
1242  $attrs += $button['attribs'];
1243  }
1244 
1245  if ( isset( $button['id'] ) ) {
1246  $attrs['id'] = $button['id'];
1247  }
1248 
1249  if ( $useMediaWikiUIEverywhere ) {
1250  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1251  $attrs['class'][] = 'mw-ui-button';
1252  }
1253 
1254  if ( $isBadIE ) {
1255  $buttons .= Html::element( 'input', $attrs ) . "\n";
1256  } else {
1257  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1258  }
1259  }
1260 
1261  if ( !$buttons ) {
1262  return '';
1263  }
1264 
1265  return Html::rawElement( 'span',
1266  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1267  }
1268 
1273  public function getBody() {
1274  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1275  }
1276 
1285  public function getErrorsOrWarnings( $elements, $elementsType ) {
1286  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1287  throw new DomainException( $elementsType . ' is not a valid type.' );
1288  }
1289  $elementstr = false;
1290  if ( $elements instanceof Status ) {
1291  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1292  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1293  if ( $status->isGood() ) {
1294  $elementstr = '';
1295  } else {
1296  $elementstr = $this->getOutput()->parseAsInterface(
1297  $status->getWikiText()
1298  );
1299  }
1300  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1301  $elementstr = $this->formatErrors( $elements );
1302  } elseif ( $elementsType === 'error' ) {
1303  $elementstr = $elements;
1304  }
1305 
1306  return $elementstr
1307  ? Html::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1308  : '';
1309  }
1310 
1318  public function formatErrors( $errors ) {
1319  $errorstr = '';
1320 
1321  foreach ( $errors as $error ) {
1322  $errorstr .= Html::rawElement(
1323  'li',
1324  [],
1325  $this->getMessage( $error )->parse()
1326  );
1327  }
1328 
1329  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1330 
1331  return $errorstr;
1332  }
1333 
1341  public function setSubmitText( $t ) {
1342  $this->mSubmitText = $t;
1343 
1344  return $this;
1345  }
1346 
1353  public function setSubmitDestructive() {
1354  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1355 
1356  return $this;
1357  }
1358 
1367  public function setSubmitTextMsg( $msg ) {
1368  if ( !$msg instanceof Message ) {
1369  $msg = $this->msg( $msg );
1370  }
1371  $this->setSubmitText( $msg->text() );
1372 
1373  return $this;
1374  }
1375 
1380  public function getSubmitText() {
1381  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1382  }
1383 
1389  public function setSubmitName( $name ) {
1390  $this->mSubmitName = $name;
1391 
1392  return $this;
1393  }
1394 
1400  public function setSubmitTooltip( $name ) {
1401  $this->mSubmitTooltip = $name;
1402 
1403  return $this;
1404  }
1405 
1414  public function setSubmitID( $t ) {
1415  $this->mSubmitID = $t;
1416 
1417  return $this;
1418  }
1419 
1435  public function setFormIdentifier( $ident ) {
1436  $this->mFormIdentifier = $ident;
1437 
1438  return $this;
1439  }
1440 
1451  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1452  $this->mShowSubmit = !$suppressSubmit;
1453 
1454  return $this;
1455  }
1456 
1463  public function showCancel( $show = true ) {
1464  $this->mShowCancel = $show;
1465  return $this;
1466  }
1467 
1474  public function setCancelTarget( $target ) {
1475  $this->mCancelTarget = $target;
1476  return $this;
1477  }
1478 
1488  public function setTableId( $id ) {
1489  $this->mTableId = $id;
1490 
1491  return $this;
1492  }
1493 
1499  public function setId( $id ) {
1500  $this->mId = $id;
1501 
1502  return $this;
1503  }
1504 
1509  public function setName( $name ) {
1510  $this->mName = $name;
1511 
1512  return $this;
1513  }
1514 
1526  public function setWrapperLegend( $legend ) {
1527  $this->mWrapperLegend = $legend;
1528 
1529  return $this;
1530  }
1531 
1539  public function setWrapperAttributes( $attributes ) {
1540  $this->mWrapperAttributes = $attributes;
1541 
1542  return $this;
1543  }
1544 
1554  public function setWrapperLegendMsg( $msg ) {
1555  if ( !$msg instanceof Message ) {
1556  $msg = $this->msg( $msg );
1557  }
1558  $this->setWrapperLegend( $msg->text() );
1559 
1560  return $this;
1561  }
1562 
1572  public function setMessagePrefix( $p ) {
1573  $this->mMessagePrefix = $p;
1574 
1575  return $this;
1576  }
1577 
1585  public function setTitle( $t ) {
1586  $this->mTitle = $t;
1587 
1588  return $this;
1589  }
1590 
1595  public function getTitle() {
1596  return $this->mTitle === false
1597  ? $this->getContext()->getTitle()
1598  : $this->mTitle;
1599  }
1600 
1608  public function setMethod( $method = 'post' ) {
1609  $this->mMethod = strtolower( $method );
1610 
1611  return $this;
1612  }
1613 
1617  public function getMethod() {
1618  return $this->mMethod;
1619  }
1620 
1630  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1631  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1632  }
1633 
1650  public function displaySection( $fields,
1651  $sectionName = '',
1652  $fieldsetIDPrefix = '',
1653  &$hasUserVisibleFields = false
1654  ) {
1655  if ( $this->mFieldData === null ) {
1656  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1657  . 'You probably called displayForm() without calling prepareForm() first.' );
1658  }
1659 
1660  $displayFormat = $this->getDisplayFormat();
1661 
1662  $html = [];
1663  $subsectionHtml = '';
1664  $hasLabel = false;
1665 
1666  // Conveniently, PHP method names are case-insensitive.
1667  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1668  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1669 
1670  foreach ( $fields as $key => $value ) {
1671  if ( $value instanceof HTMLFormField ) {
1672  $v = array_key_exists( $key, $this->mFieldData )
1673  ? $this->mFieldData[$key]
1674  : $value->getDefault();
1675 
1676  $retval = $value->$getFieldHtmlMethod( $v );
1677 
1678  // check, if the form field should be added to
1679  // the output.
1680  if ( $value->hasVisibleOutput() ) {
1681  $html[] = $retval;
1682 
1683  $labelValue = trim( $value->getLabel() );
1684  if ( $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' && $labelValue !== '' ) {
1685  $hasLabel = true;
1686  }
1687 
1688  $hasUserVisibleFields = true;
1689  }
1690  } elseif ( is_array( $value ) ) {
1691  $subsectionHasVisibleFields = false;
1692  $section =
1693  $this->displaySection( $value,
1694  "mw-htmlform-$key",
1695  "$fieldsetIDPrefix$key-",
1696  $subsectionHasVisibleFields );
1697  $legend = null;
1698 
1699  if ( $subsectionHasVisibleFields === true ) {
1700  // Display the section with various niceties.
1701  $hasUserVisibleFields = true;
1702 
1703  $legend = $this->getLegend( $key );
1704 
1705  $section = $this->getHeaderText( $key ) .
1706  $section .
1707  $this->getFooterText( $key );
1708 
1709  $attributes = [];
1710  if ( $fieldsetIDPrefix ) {
1711  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1712  }
1713  $subsectionHtml .= $this->wrapFieldSetSection(
1714  $legend, $section, $attributes, $fields === $this->mFieldTree
1715  );
1716  } else {
1717  // Just return the inputs, nothing fancy.
1718  $subsectionHtml .= $section;
1719  }
1720  }
1721  }
1722 
1723  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1724 
1725  if ( $subsectionHtml ) {
1726  if ( $this->mSubSectionBeforeFields ) {
1727  return $subsectionHtml . "\n" . $html;
1728  } else {
1729  return $html . "\n" . $subsectionHtml;
1730  }
1731  } else {
1732  return $html;
1733  }
1734  }
1735 
1743  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1744  if ( !$fieldsHtml ) {
1745  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1746  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1747  return '';
1748  }
1749 
1750  $displayFormat = $this->getDisplayFormat();
1751  $html = implode( '', $fieldsHtml );
1752 
1753  if ( $displayFormat === 'raw' ) {
1754  return $html;
1755  }
1756 
1757  $classes = [];
1758 
1759  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1760  $classes[] = 'mw-htmlform-nolabel';
1761  }
1762 
1763  $attribs = [
1764  'class' => implode( ' ', $classes ),
1765  ];
1766 
1767  if ( $sectionName ) {
1768  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1769  }
1770 
1771  if ( $displayFormat === 'table' ) {
1772  return Html::rawElement( 'table',
1773  $attribs,
1774  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1775  } elseif ( $displayFormat === 'inline' ) {
1776  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1777  } else {
1778  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1779  }
1780  }
1781 
1785  public function loadData() {
1786  $fieldData = [];
1787 
1788  foreach ( $this->mFlatFields as $fieldname => $field ) {
1789  $request = $this->getRequest();
1790  if ( $field->skipLoadData( $request ) ) {
1791  continue;
1792  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1793  $fieldData[$fieldname] = $field->getDefault();
1794  } else {
1795  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1796  }
1797  }
1798 
1799  # Filter data.
1800  foreach ( $fieldData as $name => &$value ) {
1801  $field = $this->mFlatFields[$name];
1802  $value = $field->filter( $value, $this->mFlatFields );
1803  }
1804 
1805  $this->mFieldData = $fieldData;
1806  }
1807 
1815  public function suppressReset( $suppressReset = true ) {
1816  $this->mShowReset = !$suppressReset;
1817 
1818  return $this;
1819  }
1820 
1830  public function filterDataForSubmit( $data ) {
1831  return $data;
1832  }
1833 
1842  public function getLegend( $key ) {
1843  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1844  }
1845 
1856  public function setAction( $action ) {
1857  $this->mAction = $action;
1858 
1859  return $this;
1860  }
1861 
1869  public function getAction() {
1870  // If an action is alredy provided, return it
1871  if ( $this->mAction !== false ) {
1872  return $this->mAction;
1873  }
1874 
1875  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1876  // Check whether we are in GET mode and the ArticlePath contains a "?"
1877  // meaning that getLocalURL() would return something like "index.php?title=...".
1878  // As browser remove the query string before submitting GET forms,
1879  // it means that the title would be lost. In such case use wfScript() instead
1880  // and put title in an hidden field (see getHiddenFields()).
1881  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1882  return wfScript();
1883  }
1884 
1885  return $this->getTitle()->getLocalURL();
1886  }
1887 
1898  public function setAutocomplete( $autocomplete ) {
1899  $this->mAutocomplete = $autocomplete;
1900 
1901  return $this;
1902  }
1903 
1910  protected function getMessage( $value ) {
1911  return Message::newFromSpecifier( $value )->setContext( $this );
1912  }
1913 
1923  public function needsJSForHtml5FormValidation() {
1924  foreach ( $this->mFlatFields as $fieldname => $field ) {
1925  if ( $field->needsJSForHtml5FormValidation() ) {
1926  return true;
1927  }
1928  }
1929  return false;
1930  }
1931 }
HTMLFormField [] $mFlatFields
Definition: HTMLForm.php:183
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:594
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:1923
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:1982
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
static $typeMappings
Definition: HTMLForm.php:133
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
prepareForm()
Prepare form for submission.
Definition: HTMLForm.php:515
setSubmitID( $t)
Set the id for the submit button.
Definition: HTMLForm.php:1414
$mWasSubmitted
Definition: HTMLForm.php:213
static getClassFromDescriptor( $fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:462
setPostText( $msg)
Set text at the end of the display.
Definition: HTMLForm.php:906
static newMainPage(MessageLocalizer $localizer=null)
Create a new Title for the Main Page.
Definition: Title.php:653
$mWrapperLegend
Definition: HTMLForm.php:247
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1630
getAction()
Get the value for the action attribute of the form.
Definition: HTMLForm.php:1869
setSubmitName( $name)
Definition: HTMLForm.php:1389
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1463
setFooterText( $msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:861
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:442
$mUseMultipart
Definition: HTMLForm.php:243
setTokenSalt( $salt)
Set the salt for the edit token.
Definition: HTMLForm.php:1011
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:839
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher...
Definition: HTMLForm.php:615
setSubmitTooltip( $name)
Definition: HTMLForm.php:1400
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
$mHiddenFields
Definition: HTMLForm.php:244
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:970
$value
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:1842
hasField( $fieldname)
Definition: HTMLForm.php:381
displaySection( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1650
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
$mSubmitCallback
Definition: HTMLForm.php:192
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:299
$mSubmitTooltip
Definition: HTMLForm.php:208
IContextSource $context
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
setCollapsibleOptions( $collapsedByDefault=false)
Enable collapsible mode, and set whether the form is collapsed by default.
Definition: HTMLForm.php:1068
setId( $id)
Definition: HTMLForm.php:1499
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:276
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. '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 '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 since 1.28! 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:1980
getHiddenFields()
Get the hidden fields that should go inside the form.
Definition: HTMLForm.php:1130
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:254
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:938
if( $line===false) $args
Definition: cdb.php:64
bool string $mAction
Form action URL.
Definition: HTMLForm.php:220
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1608
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:490
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:323
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 '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:1263
displayForm( $submitResult)
Display the form (sending to the context&#39;s OutputPage object), with an appropriate error message or s...
Definition: HTMLForm.php:1029
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:270
setSubmitText( $t)
Set the text for the submit button.
Definition: HTMLForm.php:1341
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:576
static $mFieldData
Definition: HTMLForm.php:135
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1474
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:921
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1353
getHTML( $submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1041
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:1910
$mWrapperAttributes
Definition: HTMLForm.php:248
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:1295
setFormIdentifier( $ident)
Set an internal identifier for this form.
Definition: HTMLForm.php:1435
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:1488
$res
Definition: database.txt:21
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
getTitle()
Get the title.
Definition: HTMLForm.php:1595
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:806
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:1318
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: HTMLForm.php:1112
getContext()
Get the base IContextSource object.
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1078
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:1982
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:1830
setValidationErrorMessage( $msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:719
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields&#39; HTML, merging it and wrapping.
Definition: HTMLForm.php:1743
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
array $availableSubclassDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:287
addPreText( $msg)
Add HTML to introductory message.
Definition: HTMLForm.php:759
setMessagePrefix( $p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1572
setSubmitCallback( $cb)
Set a callback to a function to do something with the form once it&#39;s been successfully validated...
Definition: HTMLForm.php:705
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1380
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
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:3051
$mCancelTarget
Definition: HTMLForm.php:190
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:691
$mFormIdentifier
Definition: HTMLForm.php:210
setWrapperAttributes( $attributes)
For internal use only.
Definition: HTMLForm.php:1539
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
Compact stacked vertical format for forms.
getField( $fieldname)
Definition: HTMLForm.php:390
$mSectionFooters
Definition: HTMLForm.php:199
getPreText()
Get the introductory message HTML.
Definition: HTMLForm.php:772
$parent
Definition: pageupdater.txt:71
static newFromSpecifier( $value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:427
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:1785
setAction( $action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1856
suppressReset( $suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1815
getFooterText( $section=null)
Get footer text.
Definition: HTMLForm.php:878
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:797
getErrorsOrWarnings( $elements, $elementsType)
Returns a formatted list of errors or warnings from the given elements.
Definition: HTMLForm.php:1285
getHeaderText( $section=null)
Get header text.
Definition: HTMLForm.php:823
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:538
Compact stacked vertical format for forms, implemented using OOUI widgets.
setIntro( $msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:732
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1367
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$mSectionHeaders
Definition: HTMLForm.php:198
setAutocomplete( $autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1898
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element...
Definition: HTMLForm.php:1554
$mMessagePrefix
Definition: HTMLForm.php:180
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1273
setPreText( $msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:746
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1451
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2194
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:784
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1164
setDisplayFormat( $format)
Set format in which to display the form.
Definition: HTMLForm.php:407
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:2633
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:263
addPostText( $msg)
Add text to the end of the display.
Definition: HTMLForm.php:893
setName( $name)
Definition: HTMLForm.php:1509
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element...
Definition: HTMLForm.php:1526
setTitle( $t)
Set the title for form submission.
Definition: HTMLForm.php:1585