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  'language' => HTMLSelectLanguageField::class,
163  'date' => HTMLDateTimeField::class,
164  'time' => HTMLDateTimeField::class,
165  'datetime' => HTMLDateTimeField::class,
166  'expiry' => HTMLExpiryField::class,
167  // HTMLTextField will output the correct type="" attribute automagically.
168  // There are about four zillion other HTML5 input types, like range, but
169  // we don't use those at the moment, so no point in adding all of them.
170  'email' => HTMLTextField::class,
171  'password' => HTMLTextField::class,
172  'url' => HTMLTextField::class,
173  'title' => HTMLTitleTextField::class,
174  'user' => HTMLUserTextField::class,
175  'usersmultiselect' => HTMLUsersMultiselectField::class,
176  'titlesmultiselect' => HTMLTitlesMultiselectField::class,
177  'namespacesmultiselect' => HTMLNamespacesMultiselectField::class,
178  ];
179 
180  public $mFieldData;
181 
182  protected $mMessagePrefix;
183 
185  protected $mFlatFields;
186 
187  protected $mFieldTree;
188  protected $mShowReset = false;
189  protected $mShowSubmit = true;
190  protected $mSubmitFlags = [ 'primary', 'progressive' ];
191  protected $mShowCancel = false;
192  protected $mCancelTarget;
193 
194  protected $mSubmitCallback;
196 
197  protected $mPre = '';
198  protected $mHeader = '';
199  protected $mFooter = '';
200  protected $mSectionHeaders = [];
201  protected $mSectionFooters = [];
202  protected $mPost = '';
203  protected $mId;
204  protected $mName;
205  protected $mTableId = '';
206 
207  protected $mSubmitID;
208  protected $mSubmitName;
209  protected $mSubmitText;
210  protected $mSubmitTooltip;
211 
212  protected $mFormIdentifier;
213  protected $mTitle;
214  protected $mMethod = 'post';
215  protected $mWasSubmitted = false;
216 
222  protected $mAction = false;
223 
229  protected $mCollapsible = false;
230 
236  protected $mCollapsed = false;
237 
243  protected $mAutocomplete = null;
244 
245  protected $mUseMultipart = false;
246  protected $mHiddenFields = [];
247  protected $mButtons = [];
248 
249  protected $mWrapperLegend = false;
250  protected $mWrapperAttributes = [];
251 
256  protected $mTokenSalt = '';
257 
265  protected $mSubSectionBeforeFields = true;
266 
272  protected $displayFormat = 'table';
273 
279  'table',
280  'div',
281  'raw',
282  'inline',
283  ];
284 
290  'vform',
291  'ooui',
292  ];
293 
301  public static function factory( $displayFormat/*, $arguments...*/ ) {
302  $arguments = func_get_args();
303  array_shift( $arguments );
304 
305  switch ( $displayFormat ) {
306  case 'vform':
307  return ObjectFactory::constructClassInstance( VFormHTMLForm::class, $arguments );
308  case 'ooui':
309  return ObjectFactory::constructClassInstance( OOUIHTMLForm::class, $arguments );
310  default:
312  $form = ObjectFactory::constructClassInstance( self::class, $arguments );
313  $form->setDisplayFormat( $displayFormat );
314  return $form;
315  }
316  }
317 
326  public function __construct( $descriptor, /*IContextSource*/ $context = null,
327  $messagePrefix = ''
328  ) {
329  if ( $context instanceof IContextSource ) {
330  $this->setContext( $context );
331  $this->mTitle = false; // We don't need them to set a title
332  $this->mMessagePrefix = $messagePrefix;
333  } elseif ( $context === null && $messagePrefix !== '' ) {
334  $this->mMessagePrefix = $messagePrefix;
335  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
336  // B/C since 1.18
337  // it's actually $messagePrefix
338  $this->mMessagePrefix = $context;
339  }
340 
341  // Evil hack for mobile :(
342  if (
343  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
344  && $this->displayFormat === 'table'
345  ) {
346  $this->displayFormat = 'div';
347  }
348 
349  // Expand out into a tree.
350  $loadedDescriptor = [];
351  $this->mFlatFields = [];
352 
353  foreach ( $descriptor as $fieldname => $info ) {
354  $section = $info['section'] ?? '';
355 
356  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
357  $this->mUseMultipart = true;
358  }
359 
360  $field = static::loadInputFromParameters( $fieldname, $info, $this );
361 
362  $setSection =& $loadedDescriptor;
363  if ( $section ) {
364  foreach ( explode( '/', $section ) as $newName ) {
365  if ( !isset( $setSection[$newName] ) ) {
366  $setSection[$newName] = [];
367  }
368 
369  $setSection =& $setSection[$newName];
370  }
371  }
372 
373  $setSection[$fieldname] = $field;
374  $this->mFlatFields[$fieldname] = $field;
375  }
376 
377  $this->mFieldTree = $loadedDescriptor;
378  }
379 
384  public function hasField( $fieldname ) {
385  return isset( $this->mFlatFields[$fieldname] );
386  }
387 
393  public function getField( $fieldname ) {
394  if ( !$this->hasField( $fieldname ) ) {
395  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
396  }
397  return $this->mFlatFields[$fieldname];
398  }
399 
410  public function setDisplayFormat( $format ) {
411  if (
412  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
413  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
414  ) {
415  throw new MWException( 'Cannot change display format after creation, ' .
416  'use HTMLForm::factory() instead' );
417  }
418 
419  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
420  throw new MWException( 'Display format must be one of ' .
421  print_r(
422  array_merge(
423  $this->availableDisplayFormats,
424  $this->availableSubclassDisplayFormats
425  ),
426  true
427  ) );
428  }
429 
430  // Evil hack for mobile :(
431  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
432  $format = 'div';
433  }
434 
435  $this->displayFormat = $format;
436 
437  return $this;
438  }
439 
445  public function getDisplayFormat() {
446  return $this->displayFormat;
447  }
448 
465  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
466  if ( isset( $descriptor['class'] ) ) {
467  $class = $descriptor['class'];
468  } elseif ( isset( $descriptor['type'] ) ) {
469  $class = static::$typeMappings[$descriptor['type']];
470  $descriptor['class'] = $class;
471  } else {
472  $class = null;
473  }
474 
475  if ( !$class ) {
476  throw new MWException( "Descriptor with no class for $fieldname: "
477  . print_r( $descriptor, true ) );
478  }
479 
480  return $class;
481  }
482 
493  public static function loadInputFromParameters( $fieldname, $descriptor,
495  ) {
496  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
497 
498  $descriptor['fieldname'] = $fieldname;
499  if ( $parent ) {
500  $descriptor['parent'] = $parent;
501  }
502 
503  # @todo This will throw a fatal error whenever someone try to use
504  # 'class' to feed a CSS class instead of 'cssclass'. Would be
505  # great to avoid the fatal error and show a nice error.
506  return new $class( $descriptor );
507  }
508 
518  public function prepareForm() {
519  # Check if we have the info we need
520  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
521  throw new MWException( 'You must call setTitle() on an HTMLForm' );
522  }
523 
524  # Load data from the request.
525  if (
526  $this->mFormIdentifier === null ||
527  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
528  ) {
529  $this->loadData();
530  } else {
531  $this->mFieldData = [];
532  }
533 
534  return $this;
535  }
536 
541  public function tryAuthorizedSubmit() {
542  $result = false;
543 
544  if ( $this->mFormIdentifier === null ) {
545  $identOkay = true;
546  } else {
547  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
548  }
549 
550  $tokenOkay = false;
551  if ( $this->getMethod() !== 'post' ) {
552  $tokenOkay = true; // no session check needed
553  } elseif ( $this->getRequest()->wasPosted() ) {
554  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
555  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
556  // Session tokens for logged-out users have no security value.
557  // However, if the user gave one, check it in order to give a nice
558  // "session expired" error instead of "permission denied" or such.
559  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
560  } else {
561  $tokenOkay = true;
562  }
563  }
564 
565  if ( $tokenOkay && $identOkay ) {
566  $this->mWasSubmitted = true;
567  $result = $this->trySubmit();
568  }
569 
570  return $result;
571  }
572 
579  public function show() {
580  $this->prepareForm();
581 
582  $result = $this->tryAuthorizedSubmit();
583  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
584  return $result;
585  }
586 
587  $this->displayForm( $result );
588 
589  return false;
590  }
591 
597  public function showAlways() {
598  $this->prepareForm();
599 
600  $result = $this->tryAuthorizedSubmit();
601 
602  $this->displayForm( $result );
603 
604  return $result;
605  }
606 
618  public function trySubmit() {
619  $valid = true;
620  $hoistedErrors = Status::newGood();
621  if ( $this->mValidationErrorMessage ) {
622  foreach ( $this->mValidationErrorMessage as $error ) {
623  $hoistedErrors->fatal( ...$error );
624  }
625  } else {
626  $hoistedErrors->fatal( 'htmlform-invalid-input' );
627  }
628 
629  $this->mWasSubmitted = true;
630 
631  # Check for cancelled submission
632  foreach ( $this->mFlatFields as $fieldname => $field ) {
633  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
634  continue;
635  }
636  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
637  $this->mWasSubmitted = false;
638  return false;
639  }
640  }
641 
642  # Check for validation
643  foreach ( $this->mFlatFields as $fieldname => $field ) {
644  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
645  continue;
646  }
647  if ( $field->isHidden( $this->mFieldData ) ) {
648  continue;
649  }
650  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
651  if ( $res !== true ) {
652  $valid = false;
653  if ( $res !== false && !$field->canDisplayErrors() ) {
654  if ( is_string( $res ) ) {
655  $hoistedErrors->fatal( 'rawmessage', $res );
656  } else {
657  $hoistedErrors->fatal( $res );
658  }
659  }
660  }
661  }
662 
663  if ( !$valid ) {
664  return $hoistedErrors;
665  }
666 
667  $callback = $this->mSubmitCallback;
668  if ( !is_callable( $callback ) ) {
669  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
670  'setSubmitCallback() to set one.' );
671  }
672 
673  $data = $this->filterDataForSubmit( $this->mFieldData );
674 
675  $res = call_user_func( $callback, $data, $this );
676  if ( $res === false ) {
677  $this->mWasSubmitted = false;
678  }
679 
680  return $res;
681  }
682 
694  public function wasSubmitted() {
695  return $this->mWasSubmitted;
696  }
697 
708  public function setSubmitCallback( $cb ) {
709  $this->mSubmitCallback = $cb;
710 
711  return $this;
712  }
713 
722  public function setValidationErrorMessage( $msg ) {
723  $this->mValidationErrorMessage = $msg;
724 
725  return $this;
726  }
727 
735  public function setIntro( $msg ) {
736  $this->setPreText( $msg );
737 
738  return $this;
739  }
740 
749  public function setPreText( $msg ) {
750  $this->mPre = $msg;
751 
752  return $this;
753  }
754 
762  public function addPreText( $msg ) {
763  $this->mPre .= $msg;
764 
765  return $this;
766  }
767 
775  public function getPreText() {
776  return $this->mPre;
777  }
778 
787  public function addHeaderText( $msg, $section = null ) {
788  if ( $section === null ) {
789  $this->mHeader .= $msg;
790  } else {
791  if ( !isset( $this->mSectionHeaders[$section] ) ) {
792  $this->mSectionHeaders[$section] = '';
793  }
794  $this->mSectionHeaders[$section] .= $msg;
795  }
796 
797  return $this;
798  }
799 
809  public function setHeaderText( $msg, $section = null ) {
810  if ( $section === null ) {
811  $this->mHeader = $msg;
812  } else {
813  $this->mSectionHeaders[$section] = $msg;
814  }
815 
816  return $this;
817  }
818 
826  public function getHeaderText( $section = null ) {
827  if ( $section === null ) {
828  return $this->mHeader;
829  } else {
830  return $this->mSectionHeaders[$section] ?? '';
831  }
832  }
833 
842  public function addFooterText( $msg, $section = null ) {
843  if ( $section === null ) {
844  $this->mFooter .= $msg;
845  } else {
846  if ( !isset( $this->mSectionFooters[$section] ) ) {
847  $this->mSectionFooters[$section] = '';
848  }
849  $this->mSectionFooters[$section] .= $msg;
850  }
851 
852  return $this;
853  }
854 
864  public function setFooterText( $msg, $section = null ) {
865  if ( $section === null ) {
866  $this->mFooter = $msg;
867  } else {
868  $this->mSectionFooters[$section] = $msg;
869  }
870 
871  return $this;
872  }
873 
881  public function getFooterText( $section = null ) {
882  if ( $section === null ) {
883  return $this->mFooter;
884  } else {
885  return $this->mSectionFooters[$section] ?? '';
886  }
887  }
888 
896  public function addPostText( $msg ) {
897  $this->mPost .= $msg;
898 
899  return $this;
900  }
901 
909  public function setPostText( $msg ) {
910  $this->mPost = $msg;
911 
912  return $this;
913  }
914 
924  public function addHiddenField( $name, $value, array $attribs = [] ) {
925  $attribs += [ 'name' => $name ];
926  $this->mHiddenFields[] = [ $value, $attribs ];
927 
928  return $this;
929  }
930 
941  public function addHiddenFields( array $fields ) {
942  foreach ( $fields as $name => $value ) {
943  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
944  }
945 
946  return $this;
947  }
948 
973  public function addButton( $data ) {
974  if ( !is_array( $data ) ) {
975  $args = func_get_args();
976  if ( count( $args ) < 2 || count( $args ) > 4 ) {
977  throw new InvalidArgumentException(
978  'Incorrect number of arguments for deprecated calling style'
979  );
980  }
981  $data = [
982  'name' => $args[0],
983  'value' => $args[1],
984  'id' => $args[2] ?? null,
985  'attribs' => $args[3] ?? null,
986  ];
987  } else {
988  if ( !isset( $data['name'] ) ) {
989  throw new InvalidArgumentException( 'A name is required' );
990  }
991  if ( !isset( $data['value'] ) ) {
992  throw new InvalidArgumentException( 'A value is required' );
993  }
994  }
995  $this->mButtons[] = $data + [
996  'id' => null,
997  'attribs' => null,
998  'flags' => null,
999  'framed' => true,
1000  ];
1001 
1002  return $this;
1003  }
1004 
1014  public function setTokenSalt( $salt ) {
1015  $this->mTokenSalt = $salt;
1016 
1017  return $this;
1018  }
1019 
1032  public function displayForm( $submitResult ) {
1033  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1034  }
1035 
1044  public function getHTML( $submitResult ) {
1045  # For good measure (it is the default)
1046  $this->getOutput()->preventClickjacking();
1047  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1048  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1049 
1050  $html = ''
1051  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1052  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1053  . $this->getHeaderText()
1054  . $this->getBody()
1055  . $this->getHiddenFields()
1056  . $this->getButtons()
1057  . $this->getFooterText();
1058 
1059  $html = $this->wrapForm( $html );
1060 
1061  return '' . $this->mPre . $html . $this->mPost;
1062  }
1063 
1070  public function setCollapsible( $collapsed = false ) {
1071  $this->mCollapsible = true;
1072  $this->mCollapsed = $collapsed;
1073  return $this;
1074  }
1075 
1080  protected function getFormAttributes() {
1081  # Use multipart/form-data
1082  $encType = $this->mUseMultipart
1083  ? 'multipart/form-data'
1084  : 'application/x-www-form-urlencoded';
1085  # Attributes
1086  $attribs = [
1087  'class' => 'mw-htmlform',
1088  'action' => $this->getAction(),
1089  'method' => $this->getMethod(),
1090  'enctype' => $encType,
1091  ];
1092  if ( $this->mId ) {
1093  $attribs['id'] = $this->mId;
1094  }
1095  if ( is_string( $this->mAutocomplete ) ) {
1096  $attribs['autocomplete'] = $this->mAutocomplete;
1097  }
1098  if ( $this->mName ) {
1099  $attribs['name'] = $this->mName;
1100  }
1101  if ( $this->needsJSForHtml5FormValidation() ) {
1102  $attribs['novalidate'] = true;
1103  }
1104  return $attribs;
1105  }
1106 
1114  public function wrapForm( $html ) {
1115  # Include a <fieldset> wrapper for style, if requested.
1116  if ( $this->mWrapperLegend !== false ) {
1117  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1118  $html = Xml::fieldset( $legend, $html, $this->mWrapperAttributes );
1119  }
1120 
1121  return Html::rawElement(
1122  'form',
1123  $this->getFormAttributes(),
1124  $html
1125  );
1126  }
1127 
1132  public function getHiddenFields() {
1133  $html = '';
1134  if ( $this->mFormIdentifier !== null ) {
1135  $html .= Html::hidden(
1136  'wpFormIdentifier',
1137  $this->mFormIdentifier
1138  ) . "\n";
1139  }
1140  if ( $this->getMethod() === 'post' ) {
1141  $html .= Html::hidden(
1142  'wpEditToken',
1143  $this->getUser()->getEditToken( $this->mTokenSalt ),
1144  [ 'id' => 'wpEditToken' ]
1145  ) . "\n";
1146  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1147  }
1148 
1149  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1150  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1151  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1152  }
1153 
1154  foreach ( $this->mHiddenFields as $data ) {
1155  list( $value, $attribs ) = $data;
1156  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1157  }
1158 
1159  return $html;
1160  }
1161 
1166  public function getButtons() {
1167  $buttons = '';
1168  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1169 
1170  if ( $this->mShowSubmit ) {
1171  $attribs = [];
1172 
1173  if ( isset( $this->mSubmitID ) ) {
1174  $attribs['id'] = $this->mSubmitID;
1175  }
1176 
1177  if ( isset( $this->mSubmitName ) ) {
1178  $attribs['name'] = $this->mSubmitName;
1179  }
1180 
1181  if ( isset( $this->mSubmitTooltip ) ) {
1182  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1183  }
1184 
1185  $attribs['class'] = [ 'mw-htmlform-submit' ];
1186 
1187  if ( $useMediaWikiUIEverywhere ) {
1188  foreach ( $this->mSubmitFlags as $flag ) {
1189  $attribs['class'][] = 'mw-ui-' . $flag;
1190  }
1191  $attribs['class'][] = 'mw-ui-button';
1192  }
1193 
1194  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1195  }
1196 
1197  if ( $this->mShowReset ) {
1198  $buttons .= Html::element(
1199  'input',
1200  [
1201  'type' => 'reset',
1202  'value' => $this->msg( 'htmlform-reset' )->text(),
1203  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1204  ]
1205  ) . "\n";
1206  }
1207 
1208  if ( $this->mShowCancel ) {
1209  $target = $this->mCancelTarget ?: Title::newMainPage();
1210  if ( $target instanceof Title ) {
1211  $target = $target->getLocalURL();
1212  }
1213  $buttons .= Html::element(
1214  'a',
1215  [
1216  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1217  'href' => $target,
1218  ],
1219  $this->msg( 'cancel' )->text()
1220  ) . "\n";
1221  }
1222 
1223  // IE<8 has bugs with <button>, so we'll need to avoid them.
1224  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1225 
1226  foreach ( $this->mButtons as $button ) {
1227  $attrs = [
1228  'type' => 'submit',
1229  'name' => $button['name'],
1230  'value' => $button['value']
1231  ];
1232 
1233  if ( isset( $button['label-message'] ) ) {
1234  $label = $this->getMessage( $button['label-message'] )->parse();
1235  } elseif ( isset( $button['label'] ) ) {
1236  $label = htmlspecialchars( $button['label'] );
1237  } elseif ( isset( $button['label-raw'] ) ) {
1238  $label = $button['label-raw'];
1239  } else {
1240  $label = htmlspecialchars( $button['value'] );
1241  }
1242 
1243  if ( $button['attribs'] ) {
1244  $attrs += $button['attribs'];
1245  }
1246 
1247  if ( isset( $button['id'] ) ) {
1248  $attrs['id'] = $button['id'];
1249  }
1250 
1251  if ( $useMediaWikiUIEverywhere ) {
1252  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1253  $attrs['class'][] = 'mw-ui-button';
1254  }
1255 
1256  if ( $isBadIE ) {
1257  $buttons .= Html::element( 'input', $attrs ) . "\n";
1258  } else {
1259  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1260  }
1261  }
1262 
1263  if ( !$buttons ) {
1264  return '';
1265  }
1266 
1267  return Html::rawElement( 'span',
1268  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1269  }
1270 
1275  public function getBody() {
1276  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1277  }
1278 
1288  public function getErrors( $errors ) {
1289  wfDeprecated( __METHOD__ );
1290  return $this->getErrorsOrWarnings( $errors, 'error' );
1291  }
1292 
1301  public function getErrorsOrWarnings( $elements, $elementsType ) {
1302  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1303  throw new DomainException( $elementsType . ' is not a valid type.' );
1304  }
1305  $elementstr = false;
1306  if ( $elements instanceof Status ) {
1307  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1308  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1309  if ( $status->isGood() ) {
1310  $elementstr = '';
1311  } else {
1312  $elementstr = $this->getOutput()->parseAsInterface(
1313  $status->getWikiText()
1314  );
1315  }
1316  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1317  $elementstr = $this->formatErrors( $elements );
1318  } elseif ( $elementsType === 'error' ) {
1319  $elementstr = $elements;
1320  }
1321 
1322  return $elementstr
1323  ? Html::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1324  : '';
1325  }
1326 
1334  public function formatErrors( $errors ) {
1335  $errorstr = '';
1336 
1337  foreach ( $errors as $error ) {
1338  $errorstr .= Html::rawElement(
1339  'li',
1340  [],
1341  $this->getMessage( $error )->parse()
1342  );
1343  }
1344 
1345  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1346 
1347  return $errorstr;
1348  }
1349 
1357  public function setSubmitText( $t ) {
1358  $this->mSubmitText = $t;
1359 
1360  return $this;
1361  }
1362 
1369  public function setSubmitDestructive() {
1370  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1371 
1372  return $this;
1373  }
1374 
1383  public function setSubmitProgressive() {
1384  wfDeprecated( __METHOD__, '1.32' );
1385  $this->mSubmitFlags = [ 'progressive', 'primary' ];
1386 
1387  return $this;
1388  }
1389 
1398  public function setSubmitTextMsg( $msg ) {
1399  if ( !$msg instanceof Message ) {
1400  $msg = $this->msg( $msg );
1401  }
1402  $this->setSubmitText( $msg->text() );
1403 
1404  return $this;
1405  }
1406 
1411  public function getSubmitText() {
1412  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1413  }
1414 
1420  public function setSubmitName( $name ) {
1421  $this->mSubmitName = $name;
1422 
1423  return $this;
1424  }
1425 
1431  public function setSubmitTooltip( $name ) {
1432  $this->mSubmitTooltip = $name;
1433 
1434  return $this;
1435  }
1436 
1445  public function setSubmitID( $t ) {
1446  $this->mSubmitID = $t;
1447 
1448  return $this;
1449  }
1450 
1466  public function setFormIdentifier( $ident ) {
1467  $this->mFormIdentifier = $ident;
1468 
1469  return $this;
1470  }
1471 
1482  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1483  $this->mShowSubmit = !$suppressSubmit;
1484 
1485  return $this;
1486  }
1487 
1494  public function showCancel( $show = true ) {
1495  $this->mShowCancel = $show;
1496  return $this;
1497  }
1498 
1505  public function setCancelTarget( $target ) {
1506  $this->mCancelTarget = $target;
1507  return $this;
1508  }
1509 
1519  public function setTableId( $id ) {
1520  $this->mTableId = $id;
1521 
1522  return $this;
1523  }
1524 
1530  public function setId( $id ) {
1531  $this->mId = $id;
1532 
1533  return $this;
1534  }
1535 
1540  public function setName( $name ) {
1541  $this->mName = $name;
1542 
1543  return $this;
1544  }
1545 
1557  public function setWrapperLegend( $legend ) {
1558  $this->mWrapperLegend = $legend;
1559 
1560  return $this;
1561  }
1562 
1570  public function setWrapperAttributes( $attributes ) {
1571  $this->mWrapperAttributes = $attributes;
1572 
1573  return $this;
1574  }
1575 
1585  public function setWrapperLegendMsg( $msg ) {
1586  if ( !$msg instanceof Message ) {
1587  $msg = $this->msg( $msg );
1588  }
1589  $this->setWrapperLegend( $msg->text() );
1590 
1591  return $this;
1592  }
1593 
1603  public function setMessagePrefix( $p ) {
1604  $this->mMessagePrefix = $p;
1605 
1606  return $this;
1607  }
1608 
1616  public function setTitle( $t ) {
1617  $this->mTitle = $t;
1618 
1619  return $this;
1620  }
1621 
1626  public function getTitle() {
1627  return $this->mTitle === false
1628  ? $this->getContext()->getTitle()
1629  : $this->mTitle;
1630  }
1631 
1639  public function setMethod( $method = 'post' ) {
1640  $this->mMethod = strtolower( $method );
1641 
1642  return $this;
1643  }
1644 
1648  public function getMethod() {
1649  return $this->mMethod;
1650  }
1651 
1661  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1662  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1663  }
1664 
1681  public function displaySection( $fields,
1682  $sectionName = '',
1683  $fieldsetIDPrefix = '',
1684  &$hasUserVisibleFields = false
1685  ) {
1686  if ( $this->mFieldData === null ) {
1687  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1688  . 'You probably called displayForm() without calling prepareForm() first.' );
1689  }
1690 
1691  $displayFormat = $this->getDisplayFormat();
1692 
1693  $html = [];
1694  $subsectionHtml = '';
1695  $hasLabel = false;
1696 
1697  // Conveniently, PHP method names are case-insensitive.
1698  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1699  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1700 
1701  foreach ( $fields as $key => $value ) {
1702  if ( $value instanceof HTMLFormField ) {
1703  $v = array_key_exists( $key, $this->mFieldData )
1704  ? $this->mFieldData[$key]
1705  : $value->getDefault();
1706 
1707  $retval = $value->$getFieldHtmlMethod( $v );
1708 
1709  // check, if the form field should be added to
1710  // the output.
1711  if ( $value->hasVisibleOutput() ) {
1712  $html[] = $retval;
1713 
1714  $labelValue = trim( $value->getLabel() );
1715  if ( $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' && $labelValue !== '' ) {
1716  $hasLabel = true;
1717  }
1718 
1719  $hasUserVisibleFields = true;
1720  }
1721  } elseif ( is_array( $value ) ) {
1722  $subsectionHasVisibleFields = false;
1723  $section =
1724  $this->displaySection( $value,
1725  "mw-htmlform-$key",
1726  "$fieldsetIDPrefix$key-",
1727  $subsectionHasVisibleFields );
1728  $legend = null;
1729 
1730  if ( $subsectionHasVisibleFields === true ) {
1731  // Display the section with various niceties.
1732  $hasUserVisibleFields = true;
1733 
1734  $legend = $this->getLegend( $key );
1735 
1736  $section = $this->getHeaderText( $key ) .
1737  $section .
1738  $this->getFooterText( $key );
1739 
1740  $attributes = [];
1741  if ( $fieldsetIDPrefix ) {
1742  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1743  }
1744  $subsectionHtml .= $this->wrapFieldSetSection(
1745  $legend, $section, $attributes, $fields === $this->mFieldTree
1746  );
1747  } else {
1748  // Just return the inputs, nothing fancy.
1749  $subsectionHtml .= $section;
1750  }
1751  }
1752  }
1753 
1754  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1755 
1756  if ( $subsectionHtml ) {
1757  if ( $this->mSubSectionBeforeFields ) {
1758  return $subsectionHtml . "\n" . $html;
1759  } else {
1760  return $html . "\n" . $subsectionHtml;
1761  }
1762  } else {
1763  return $html;
1764  }
1765  }
1766 
1774  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1775  if ( !$fieldsHtml ) {
1776  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1777  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1778  return '';
1779  }
1780 
1781  $displayFormat = $this->getDisplayFormat();
1782  $html = implode( '', $fieldsHtml );
1783 
1784  if ( $displayFormat === 'raw' ) {
1785  return $html;
1786  }
1787 
1788  $classes = [];
1789 
1790  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1791  $classes[] = 'mw-htmlform-nolabel';
1792  }
1793 
1794  $attribs = [
1795  'class' => implode( ' ', $classes ),
1796  ];
1797 
1798  if ( $sectionName ) {
1799  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1800  }
1801 
1802  if ( $displayFormat === 'table' ) {
1803  return Html::rawElement( 'table',
1804  $attribs,
1805  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1806  } elseif ( $displayFormat === 'inline' ) {
1807  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1808  } else {
1809  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1810  }
1811  }
1812 
1816  public function loadData() {
1817  $fieldData = [];
1818 
1819  foreach ( $this->mFlatFields as $fieldname => $field ) {
1820  $request = $this->getRequest();
1821  if ( $field->skipLoadData( $request ) ) {
1822  continue;
1823  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1824  $fieldData[$fieldname] = $field->getDefault();
1825  } else {
1826  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1827  }
1828  }
1829 
1830  # Filter data.
1831  foreach ( $fieldData as $name => &$value ) {
1832  $field = $this->mFlatFields[$name];
1833  $value = $field->filter( $value, $this->mFlatFields );
1834  }
1835 
1836  $this->mFieldData = $fieldData;
1837  }
1838 
1846  public function suppressReset( $suppressReset = true ) {
1847  $this->mShowReset = !$suppressReset;
1848 
1849  return $this;
1850  }
1851 
1861  public function filterDataForSubmit( $data ) {
1862  return $data;
1863  }
1864 
1873  public function getLegend( $key ) {
1874  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1875  }
1876 
1887  public function setAction( $action ) {
1888  $this->mAction = $action;
1889 
1890  return $this;
1891  }
1892 
1900  public function getAction() {
1901  // If an action is alredy provided, return it
1902  if ( $this->mAction !== false ) {
1903  return $this->mAction;
1904  }
1905 
1906  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1907  // Check whether we are in GET mode and the ArticlePath contains a "?"
1908  // meaning that getLocalURL() would return something like "index.php?title=...".
1909  // As browser remove the query string before submitting GET forms,
1910  // it means that the title would be lost. In such case use wfScript() instead
1911  // and put title in an hidden field (see getHiddenFields()).
1912  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1913  return wfScript();
1914  }
1915 
1916  return $this->getTitle()->getLocalURL();
1917  }
1918 
1929  public function setAutocomplete( $autocomplete ) {
1930  $this->mAutocomplete = $autocomplete;
1931 
1932  return $this;
1933  }
1934 
1941  protected function getMessage( $value ) {
1942  return Message::newFromSpecifier( $value )->setContext( $this );
1943  }
1944 
1954  public function needsJSForHtml5FormValidation() {
1955  foreach ( $this->mFlatFields as $fieldname => $field ) {
1956  if ( $field->needsJSForHtml5FormValidation() ) {
1957  return true;
1958  }
1959  }
1960  return false;
1961  }
1962 }
HTMLFormField [] $mFlatFields
Definition: HTMLForm.php:185
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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:597
string null $mAutocomplete
Form attribute autocomplete.
Definition: HTMLForm.php:243
needsJSForHtml5FormValidation()
Whether this form, with its current fields, requires the user agent to have JavaScript enabled for th...
Definition: HTMLForm.php:1954
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
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
static $typeMappings
Definition: HTMLForm.php:135
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:518
setSubmitID( $t)
Set the id for the submit button.
Definition: HTMLForm.php:1445
$mWasSubmitted
Definition: HTMLForm.php:215
static getClassFromDescriptor( $fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:465
setPostText( $msg)
Set text at the end of the display.
Definition: HTMLForm.php:909
static newMainPage(MessageLocalizer $localizer=null)
Create a new Title for the Main Page.
Definition: Title.php:653
$mWrapperLegend
Definition: HTMLForm.php:249
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1661
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:1900
setSubmitName( $name)
Definition: HTMLForm.php:1420
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1494
setFooterText( $msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:864
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:445
$mUseMultipart
Definition: HTMLForm.php:245
setTokenSalt( $salt)
Set the salt for the edit token.
Definition: HTMLForm.php:1014
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:842
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher...
Definition: HTMLForm.php:618
setSubmitTooltip( $name)
Definition: HTMLForm.php:1431
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
$mHiddenFields
Definition: HTMLForm.php:246
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:973
$value
bool $mCollapsed
Whether the HTML form IS collapsed by default.
Definition: HTMLForm.php:236
getLegend( $key)
Get a string to go in the "<legend>" of a section fieldset.
Definition: HTMLForm.php:1873
hasField( $fieldname)
Definition: HTMLForm.php:384
displaySection( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1681
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
$mSubmitCallback
Definition: HTMLForm.php:194
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:301
$mSubmitTooltip
Definition: HTMLForm.php:210
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
setId( $id)
Definition: HTMLForm.php:1530
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:278
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:1132
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:256
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:941
if( $line===false) $args
Definition: cdb.php:64
bool string $mAction
Form action URL.
Definition: HTMLForm.php:222
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1639
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
$mValidationErrorMessage
Definition: HTMLForm.php:195
setSubmitProgressive()
Identify that the submit button in the form has a progressive action.
Definition: HTMLForm.php:1383
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: HTMLForm.php:493
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:326
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:1032
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:272
setSubmitText( $t)
Set the text for the submit button.
Definition: HTMLForm.php:1357
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:579
static $mFieldData
Definition: HTMLForm.php:137
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1505
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:924
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1369
getHTML( $submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1044
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:1941
$mWrapperAttributes
Definition: HTMLForm.php:250
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:1287
setFormIdentifier( $ident)
Set an internal identifier for this form.
Definition: HTMLForm.php:1466
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:1519
$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:1626
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:809
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:1334
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: HTMLForm.php:1114
setCollapsible( $collapsed=false)
Make the form collapsible.
Definition: HTMLForm.php:1070
getContext()
Get the base IContextSource object.
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1080
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:1861
setValidationErrorMessage( $msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:722
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields&#39; HTML, merging it and wrapping.
Definition: HTMLForm.php:1774
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:289
addPreText( $msg)
Add HTML to introductory message.
Definition: HTMLForm.php:762
setMessagePrefix( $p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1603
setSubmitCallback( $cb)
Set a callback to a function to do something with the form once it&#39;s been successfully validated...
Definition: HTMLForm.php:708
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1411
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:3050
$mCancelTarget
Definition: HTMLForm.php:192
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:694
$mFormIdentifier
Definition: HTMLForm.php:212
setWrapperAttributes( $attributes)
For internal use only.
Definition: HTMLForm.php:1570
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
getField( $fieldname)
Definition: HTMLForm.php:393
$mSectionFooters
Definition: HTMLForm.php:201
getPreText()
Get the introductory message HTML.
Definition: HTMLForm.php:775
$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:1816
setAction( $action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1887
suppressReset( $suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1846
getFooterText( $section=null)
Get footer text.
Definition: HTMLForm.php:881
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:1301
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getHeaderText( $section=null)
Get header text.
Definition: HTMLForm.php:826
getErrors( $errors)
Format and display an error message stack.
Definition: HTMLForm.php:1288
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:541
setIntro( $msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:735
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1398
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$mSectionHeaders
Definition: HTMLForm.php:200
setAutocomplete( $autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1929
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element...
Definition: HTMLForm.php:1585
$mMessagePrefix
Definition: HTMLForm.php:182
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1275
setPreText( $msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:749
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1482
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2144
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:787
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1166
setDisplayFormat( $format)
Set format in which to display the form.
Definition: HTMLForm.php:410
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 HTML form can be collapsed.
Definition: HTMLForm.php:229
$mSubSectionBeforeFields
If true, sections that contain both fields and subsections will render their subsections before their...
Definition: HTMLForm.php:265
addPostText( $msg)
Add text to the end of the display.
Definition: HTMLForm.php:896
setName( $name)
Definition: HTMLForm.php:1540
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element...
Definition: HTMLForm.php:1557
setTitle( $t)
Set the title for form submission.
Definition: HTMLForm.php:1616