MediaWiki  master
HTMLForm.php
Go to the documentation of this file.
1 <?php
2 
25 
133 class HTMLForm extends ContextSource {
134  // A mapping of 'type' inputs onto standard HTMLFormField subclasses
135  public static $typeMappings = [
136  'api' => HTMLApiField::class,
138  'textwithbutton' => HTMLTextFieldWithButton::class,
139  'textarea' => HTMLTextAreaField::class,
140  'select' => HTMLSelectField::class,
141  'combobox' => HTMLComboboxField::class,
142  'radio' => HTMLRadioField::class,
143  'multiselect' => HTMLMultiSelectField::class,
144  'limitselect' => HTMLSelectLimitField::class,
145  'check' => HTMLCheckField::class,
146  'toggle' => HTMLCheckField::class,
147  'int' => HTMLIntField::class,
148  'float' => HTMLFloatField::class,
149  'info' => HTMLInfoField::class,
150  'selectorother' => HTMLSelectOrOtherField::class,
151  'selectandother' => HTMLSelectAndOtherField::class,
152  'namespaceselect' => HTMLSelectNamespace::class,
153  'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton::class,
154  'tagfilter' => HTMLTagFilter::class,
155  'sizefilter' => HTMLSizeFilterField::class,
156  'submit' => HTMLSubmitField::class,
157  'hidden' => HTMLHiddenField::class,
158  'edittools' => HTMLEditTools::class,
159  'checkmatrix' => HTMLCheckMatrix::class,
160  'cloner' => HTMLFormFieldCloner::class,
161  'autocompleteselect' => HTMLAutoCompleteSelectField::class,
162  'date' => HTMLDateTimeField::class,
163  'time' => HTMLDateTimeField::class,
164  'datetime' => HTMLDateTimeField::class,
165  'expiry' => HTMLExpiryField::class,
166  // HTMLTextField will output the correct type="" attribute automagically.
167  // There are about four zillion other HTML5 input types, like range, but
168  // we don't use those at the moment, so no point in adding all of them.
169  'email' => HTMLTextField::class,
170  'password' => HTMLTextField::class,
171  'url' => HTMLTextField::class,
172  'title' => HTMLTitleTextField::class,
173  'user' => HTMLUserTextField::class,
174  'usersmultiselect' => HTMLUsersMultiselectField::class,
175  'titlesmultiselect' => HTMLTitlesMultiselectField::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 $mAutocomplete = null;
228 
229  protected $mUseMultipart = false;
230  protected $mHiddenFields = [];
231  protected $mButtons = [];
232 
233  protected $mWrapperLegend = false;
234 
239  protected $mTokenSalt = '';
240 
248  protected $mSubSectionBeforeFields = true;
249 
255  protected $displayFormat = 'table';
256 
262  'table',
263  'div',
264  'raw',
265  'inline',
266  ];
267 
273  'vform',
274  'ooui',
275  ];
276 
284  public static function factory( $displayFormat/*, $arguments...*/ ) {
285  $arguments = func_get_args();
286  array_shift( $arguments );
287 
288  switch ( $displayFormat ) {
289  case 'vform':
290  return ObjectFactory::constructClassInstance( VFormHTMLForm::class, $arguments );
291  case 'ooui':
292  return ObjectFactory::constructClassInstance( OOUIHTMLForm::class, $arguments );
293  default:
295  $form = ObjectFactory::constructClassInstance( self::class, $arguments );
296  $form->setDisplayFormat( $displayFormat );
297  return $form;
298  }
299  }
300 
309  public function __construct( $descriptor, /*IContextSource*/ $context = null,
310  $messagePrefix = ''
311  ) {
312  if ( $context instanceof IContextSource ) {
313  $this->setContext( $context );
314  $this->mTitle = false; // We don't need them to set a title
315  $this->mMessagePrefix = $messagePrefix;
316  } elseif ( $context === null && $messagePrefix !== '' ) {
317  $this->mMessagePrefix = $messagePrefix;
318  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
319  // B/C since 1.18
320  // it's actually $messagePrefix
321  $this->mMessagePrefix = $context;
322  }
323 
324  // Evil hack for mobile :(
325  if (
326  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
327  && $this->displayFormat === 'table'
328  ) {
329  $this->displayFormat = 'div';
330  }
331 
332  // Expand out into a tree.
333  $loadedDescriptor = [];
334  $this->mFlatFields = [];
335 
336  foreach ( $descriptor as $fieldname => $info ) {
337  $section = $info['section'] ?? '';
338 
339  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
340  $this->mUseMultipart = true;
341  }
342 
343  $field = static::loadInputFromParameters( $fieldname, $info, $this );
344 
345  $setSection =& $loadedDescriptor;
346  if ( $section ) {
347  $sectionParts = explode( '/', $section );
348 
349  while ( count( $sectionParts ) ) {
350  $newName = array_shift( $sectionParts );
351 
352  if ( !isset( $setSection[$newName] ) ) {
353  $setSection[$newName] = [];
354  }
355 
356  $setSection =& $setSection[$newName];
357  }
358  }
359 
360  $setSection[$fieldname] = $field;
361  $this->mFlatFields[$fieldname] = $field;
362  }
363 
364  $this->mFieldTree = $loadedDescriptor;
365  }
366 
371  public function hasField( $fieldname ) {
372  return isset( $this->mFlatFields[$fieldname] );
373  }
374 
380  public function getField( $fieldname ) {
381  if ( !$this->hasField( $fieldname ) ) {
382  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
383  }
384  return $this->mFlatFields[$fieldname];
385  }
386 
397  public function setDisplayFormat( $format ) {
398  if (
399  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
400  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
401  ) {
402  throw new MWException( 'Cannot change display format after creation, ' .
403  'use HTMLForm::factory() instead' );
404  }
405 
406  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
407  throw new MWException( 'Display format must be one of ' .
408  print_r(
409  array_merge(
410  $this->availableDisplayFormats,
411  $this->availableSubclassDisplayFormats
412  ),
413  true
414  ) );
415  }
416 
417  // Evil hack for mobile :(
418  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
419  $format = 'div';
420  }
421 
422  $this->displayFormat = $format;
423 
424  return $this;
425  }
426 
432  public function getDisplayFormat() {
433  return $this->displayFormat;
434  }
435 
452  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
453  if ( isset( $descriptor['class'] ) ) {
454  $class = $descriptor['class'];
455  } elseif ( isset( $descriptor['type'] ) ) {
456  $class = static::$typeMappings[$descriptor['type']];
457  $descriptor['class'] = $class;
458  } else {
459  $class = null;
460  }
461 
462  if ( !$class ) {
463  throw new MWException( "Descriptor with no class for $fieldname: "
464  . print_r( $descriptor, true ) );
465  }
466 
467  return $class;
468  }
469 
480  public static function loadInputFromParameters( $fieldname, $descriptor,
481  HTMLForm $parent = null
482  ) {
483  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
484 
485  $descriptor['fieldname'] = $fieldname;
486  if ( $parent ) {
487  $descriptor['parent'] = $parent;
488  }
489 
490  # @todo This will throw a fatal error whenever someone try to use
491  # 'class' to feed a CSS class instead of 'cssclass'. Would be
492  # great to avoid the fatal error and show a nice error.
493  return new $class( $descriptor );
494  }
495 
505  public function prepareForm() {
506  # Check if we have the info we need
507  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
508  throw new MWException( 'You must call setTitle() on an HTMLForm' );
509  }
510 
511  # Load data from the request.
512  if (
513  $this->mFormIdentifier === null ||
514  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
515  ) {
516  $this->loadData();
517  } else {
518  $this->mFieldData = [];
519  }
520 
521  return $this;
522  }
523 
528  public function tryAuthorizedSubmit() {
529  $result = false;
530 
531  $identOkay = false;
532  if ( $this->mFormIdentifier === null ) {
533  $identOkay = true;
534  } else {
535  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
536  }
537 
538  $tokenOkay = false;
539  if ( $this->getMethod() !== 'post' ) {
540  $tokenOkay = true; // no session check needed
541  } elseif ( $this->getRequest()->wasPosted() ) {
542  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
543  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
544  // Session tokens for logged-out users have no security value.
545  // However, if the user gave one, check it in order to give a nice
546  // "session expired" error instead of "permission denied" or such.
547  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
548  } else {
549  $tokenOkay = true;
550  }
551  }
552 
553  if ( $tokenOkay && $identOkay ) {
554  $this->mWasSubmitted = true;
555  $result = $this->trySubmit();
556  }
557 
558  return $result;
559  }
560 
567  public function show() {
568  $this->prepareForm();
569 
570  $result = $this->tryAuthorizedSubmit();
571  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
572  return $result;
573  }
574 
575  $this->displayForm( $result );
576 
577  return false;
578  }
579 
585  public function showAlways() {
586  $this->prepareForm();
587 
588  $result = $this->tryAuthorizedSubmit();
589 
590  $this->displayForm( $result );
591 
592  return $result;
593  }
594 
606  public function trySubmit() {
607  $valid = true;
608  $hoistedErrors = Status::newGood();
609  if ( $this->mValidationErrorMessage ) {
610  foreach ( (array)$this->mValidationErrorMessage as $error ) {
611  $hoistedErrors->fatal( ...$error );
612  }
613  } else {
614  $hoistedErrors->fatal( 'htmlform-invalid-input' );
615  }
616 
617  $this->mWasSubmitted = true;
618 
619  # Check for cancelled submission
620  foreach ( $this->mFlatFields as $fieldname => $field ) {
621  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
622  continue;
623  }
624  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
625  $this->mWasSubmitted = false;
626  return false;
627  }
628  }
629 
630  # Check for validation
631  foreach ( $this->mFlatFields as $fieldname => $field ) {
632  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
633  continue;
634  }
635  if ( $field->isHidden( $this->mFieldData ) ) {
636  continue;
637  }
638  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
639  if ( $res !== true ) {
640  $valid = false;
641  if ( $res !== false && !$field->canDisplayErrors() ) {
642  if ( is_string( $res ) ) {
643  $hoistedErrors->fatal( 'rawmessage', $res );
644  } else {
645  $hoistedErrors->fatal( $res );
646  }
647  }
648  }
649  }
650 
651  if ( !$valid ) {
652  return $hoistedErrors;
653  }
654 
655  $callback = $this->mSubmitCallback;
656  if ( !is_callable( $callback ) ) {
657  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
658  'setSubmitCallback() to set one.' );
659  }
660 
661  $data = $this->filterDataForSubmit( $this->mFieldData );
662 
663  $res = call_user_func( $callback, $data, $this );
664  if ( $res === false ) {
665  $this->mWasSubmitted = false;
666  }
667 
668  return $res;
669  }
670 
682  public function wasSubmitted() {
683  return $this->mWasSubmitted;
684  }
685 
696  public function setSubmitCallback( $cb ) {
697  $this->mSubmitCallback = $cb;
698 
699  return $this;
700  }
701 
710  public function setValidationErrorMessage( $msg ) {
711  $this->mValidationErrorMessage = $msg;
712 
713  return $this;
714  }
715 
723  public function setIntro( $msg ) {
724  $this->setPreText( $msg );
725 
726  return $this;
727  }
728 
737  public function setPreText( $msg ) {
738  $this->mPre = $msg;
739 
740  return $this;
741  }
742 
750  public function addPreText( $msg ) {
751  $this->mPre .= $msg;
752 
753  return $this;
754  }
755 
763  public function getPreText() {
764  return $this->mPre;
765  }
766 
775  public function addHeaderText( $msg, $section = null ) {
776  if ( $section === null ) {
777  $this->mHeader .= $msg;
778  } else {
779  if ( !isset( $this->mSectionHeaders[$section] ) ) {
780  $this->mSectionHeaders[$section] = '';
781  }
782  $this->mSectionHeaders[$section] .= $msg;
783  }
784 
785  return $this;
786  }
787 
797  public function setHeaderText( $msg, $section = null ) {
798  if ( $section === null ) {
799  $this->mHeader = $msg;
800  } else {
801  $this->mSectionHeaders[$section] = $msg;
802  }
803 
804  return $this;
805  }
806 
814  public function getHeaderText( $section = null ) {
815  if ( $section === null ) {
816  return $this->mHeader;
817  } else {
818  return $this->mSectionHeaders[$section] ?? '';
819  }
820  }
821 
830  public function addFooterText( $msg, $section = null ) {
831  if ( $section === null ) {
832  $this->mFooter .= $msg;
833  } else {
834  if ( !isset( $this->mSectionFooters[$section] ) ) {
835  $this->mSectionFooters[$section] = '';
836  }
837  $this->mSectionFooters[$section] .= $msg;
838  }
839 
840  return $this;
841  }
842 
852  public function setFooterText( $msg, $section = null ) {
853  if ( $section === null ) {
854  $this->mFooter = $msg;
855  } else {
856  $this->mSectionFooters[$section] = $msg;
857  }
858 
859  return $this;
860  }
861 
869  public function getFooterText( $section = null ) {
870  if ( $section === null ) {
871  return $this->mFooter;
872  } else {
873  return $this->mSectionFooters[$section] ?? '';
874  }
875  }
876 
884  public function addPostText( $msg ) {
885  $this->mPost .= $msg;
886 
887  return $this;
888  }
889 
897  public function setPostText( $msg ) {
898  $this->mPost = $msg;
899 
900  return $this;
901  }
902 
912  public function addHiddenField( $name, $value, array $attribs = [] ) {
913  $attribs += [ 'name' => $name ];
914  $this->mHiddenFields[] = [ $value, $attribs ];
915 
916  return $this;
917  }
918 
929  public function addHiddenFields( array $fields ) {
930  foreach ( $fields as $name => $value ) {
931  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
932  }
933 
934  return $this;
935  }
936 
961  public function addButton( $data ) {
962  if ( !is_array( $data ) ) {
963  $args = func_get_args();
964  if ( count( $args ) < 2 || count( $args ) > 4 ) {
965  throw new InvalidArgumentException(
966  'Incorrect number of arguments for deprecated calling style'
967  );
968  }
969  $data = [
970  'name' => $args[0],
971  'value' => $args[1],
972  'id' => $args[2] ?? null,
973  'attribs' => $args[3] ?? null,
974  ];
975  } else {
976  if ( !isset( $data['name'] ) ) {
977  throw new InvalidArgumentException( 'A name is required' );
978  }
979  if ( !isset( $data['value'] ) ) {
980  throw new InvalidArgumentException( 'A value is required' );
981  }
982  }
983  $this->mButtons[] = $data + [
984  'id' => null,
985  'attribs' => null,
986  'flags' => null,
987  'framed' => true,
988  ];
989 
990  return $this;
991  }
992 
1002  public function setTokenSalt( $salt ) {
1003  $this->mTokenSalt = $salt;
1004 
1005  return $this;
1006  }
1007 
1020  public function displayForm( $submitResult ) {
1021  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1022  }
1023 
1032  public function getHTML( $submitResult ) {
1033  # For good measure (it is the default)
1034  $this->getOutput()->preventClickjacking();
1035  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1036  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1037 
1038  $html = ''
1039  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1040  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1041  . $this->getHeaderText()
1042  . $this->getBody()
1043  . $this->getHiddenFields()
1044  . $this->getButtons()
1045  . $this->getFooterText();
1046 
1047  $html = $this->wrapForm( $html );
1048 
1049  return '' . $this->mPre . $html . $this->mPost;
1050  }
1051 
1056  protected function getFormAttributes() {
1057  # Use multipart/form-data
1058  $encType = $this->mUseMultipart
1059  ? 'multipart/form-data'
1060  : 'application/x-www-form-urlencoded';
1061  # Attributes
1062  $attribs = [
1063  'class' => 'mw-htmlform',
1064  'action' => $this->getAction(),
1065  'method' => $this->getMethod(),
1066  'enctype' => $encType,
1067  ];
1068  if ( $this->mId ) {
1069  $attribs['id'] = $this->mId;
1070  }
1071  if ( is_string( $this->mAutocomplete ) ) {
1072  $attribs['autocomplete'] = $this->mAutocomplete;
1073  }
1074  if ( $this->mName ) {
1075  $attribs['name'] = $this->mName;
1076  }
1077  if ( $this->needsJSForHtml5FormValidation() ) {
1078  $attribs['novalidate'] = true;
1079  }
1080  return $attribs;
1081  }
1082 
1090  public function wrapForm( $html ) {
1091  # Include a <fieldset> wrapper for style, if requested.
1092  if ( $this->mWrapperLegend !== false ) {
1093  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1094  $html = Xml::fieldset( $legend, $html );
1095  }
1096 
1097  return Html::rawElement(
1098  'form',
1099  $this->getFormAttributes(),
1100  $html
1101  );
1102  }
1103 
1108  public function getHiddenFields() {
1109  $html = '';
1110  if ( $this->mFormIdentifier !== null ) {
1111  $html .= Html::hidden(
1112  'wpFormIdentifier',
1113  $this->mFormIdentifier
1114  ) . "\n";
1115  }
1116  if ( $this->getMethod() === 'post' ) {
1117  $html .= Html::hidden(
1118  'wpEditToken',
1119  $this->getUser()->getEditToken( $this->mTokenSalt ),
1120  [ 'id' => 'wpEditToken' ]
1121  ) . "\n";
1122  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1123  }
1124 
1125  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1126  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1127  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1128  }
1129 
1130  foreach ( $this->mHiddenFields as $data ) {
1131  list( $value, $attribs ) = $data;
1132  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1133  }
1134 
1135  return $html;
1136  }
1137 
1142  public function getButtons() {
1143  $buttons = '';
1144  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1145 
1146  if ( $this->mShowSubmit ) {
1147  $attribs = [];
1148 
1149  if ( isset( $this->mSubmitID ) ) {
1150  $attribs['id'] = $this->mSubmitID;
1151  }
1152 
1153  if ( isset( $this->mSubmitName ) ) {
1154  $attribs['name'] = $this->mSubmitName;
1155  }
1156 
1157  if ( isset( $this->mSubmitTooltip ) ) {
1158  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1159  }
1160 
1161  $attribs['class'] = [ 'mw-htmlform-submit' ];
1162 
1163  if ( $useMediaWikiUIEverywhere ) {
1164  foreach ( $this->mSubmitFlags as $flag ) {
1165  $attribs['class'][] = 'mw-ui-' . $flag;
1166  }
1167  $attribs['class'][] = 'mw-ui-button';
1168  }
1169 
1170  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1171  }
1172 
1173  if ( $this->mShowReset ) {
1174  $buttons .= Html::element(
1175  'input',
1176  [
1177  'type' => 'reset',
1178  'value' => $this->msg( 'htmlform-reset' )->text(),
1179  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1180  ]
1181  ) . "\n";
1182  }
1183 
1184  if ( $this->mShowCancel ) {
1185  $target = $this->mCancelTarget ?: Title::newMainPage();
1186  if ( $target instanceof Title ) {
1187  $target = $target->getLocalURL();
1188  }
1189  $buttons .= Html::element(
1190  'a',
1191  [
1192  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1193  'href' => $target,
1194  ],
1195  $this->msg( 'cancel' )->text()
1196  ) . "\n";
1197  }
1198 
1199  // IE<8 has bugs with <button>, so we'll need to avoid them.
1200  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1201 
1202  foreach ( $this->mButtons as $button ) {
1203  $attrs = [
1204  'type' => 'submit',
1205  'name' => $button['name'],
1206  'value' => $button['value']
1207  ];
1208 
1209  if ( isset( $button['label-message'] ) ) {
1210  $label = $this->getMessage( $button['label-message'] )->parse();
1211  } elseif ( isset( $button['label'] ) ) {
1212  $label = htmlspecialchars( $button['label'] );
1213  } elseif ( isset( $button['label-raw'] ) ) {
1214  $label = $button['label-raw'];
1215  } else {
1216  $label = htmlspecialchars( $button['value'] );
1217  }
1218 
1219  if ( $button['attribs'] ) {
1220  $attrs += $button['attribs'];
1221  }
1222 
1223  if ( isset( $button['id'] ) ) {
1224  $attrs['id'] = $button['id'];
1225  }
1226 
1227  if ( $useMediaWikiUIEverywhere ) {
1228  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1229  $attrs['class'][] = 'mw-ui-button';
1230  }
1231 
1232  if ( $isBadIE ) {
1233  $buttons .= Html::element( 'input', $attrs ) . "\n";
1234  } else {
1235  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1236  }
1237  }
1238 
1239  if ( !$buttons ) {
1240  return '';
1241  }
1242 
1243  return Html::rawElement( 'span',
1244  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1245  }
1246 
1251  public function getBody() {
1252  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1253  }
1254 
1264  public function getErrors( $errors ) {
1265  wfDeprecated( __METHOD__ );
1266  return $this->getErrorsOrWarnings( $errors, 'error' );
1267  }
1268 
1277  public function getErrorsOrWarnings( $elements, $elementsType ) {
1278  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1279  throw new DomainException( $elementsType . ' is not a valid type.' );
1280  }
1281  $elementstr = false;
1282  if ( $elements instanceof Status ) {
1283  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1284  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1285  if ( $status->isGood() ) {
1286  $elementstr = '';
1287  } else {
1288  $elementstr = $this->getOutput()->parseAsInterface(
1289  $status->getWikiText()
1290  );
1291  }
1292  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1293  $elementstr = $this->formatErrors( $elements );
1294  } elseif ( $elementsType === 'error' ) {
1295  $elementstr = $elements;
1296  }
1297 
1298  return $elementstr
1299  ? Html::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1300  : '';
1301  }
1302 
1310  public function formatErrors( $errors ) {
1311  $errorstr = '';
1312 
1313  foreach ( $errors as $error ) {
1314  $errorstr .= Html::rawElement(
1315  'li',
1316  [],
1317  $this->getMessage( $error )->parse()
1318  );
1319  }
1320 
1321  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1322 
1323  return $errorstr;
1324  }
1325 
1333  public function setSubmitText( $t ) {
1334  $this->mSubmitText = $t;
1335 
1336  return $this;
1337  }
1338 
1345  public function setSubmitDestructive() {
1346  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1347 
1348  return $this;
1349  }
1350 
1359  public function setSubmitProgressive() {
1360  wfDeprecated( __METHOD__, '1.32' );
1361  $this->mSubmitFlags = [ 'progressive', 'primary' ];
1362 
1363  return $this;
1364  }
1365 
1374  public function setSubmitTextMsg( $msg ) {
1375  if ( !$msg instanceof Message ) {
1376  $msg = $this->msg( $msg );
1377  }
1378  $this->setSubmitText( $msg->text() );
1379 
1380  return $this;
1381  }
1382 
1387  public function getSubmitText() {
1388  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1389  }
1390 
1396  public function setSubmitName( $name ) {
1397  $this->mSubmitName = $name;
1398 
1399  return $this;
1400  }
1401 
1407  public function setSubmitTooltip( $name ) {
1408  $this->mSubmitTooltip = $name;
1409 
1410  return $this;
1411  }
1412 
1421  public function setSubmitID( $t ) {
1422  $this->mSubmitID = $t;
1423 
1424  return $this;
1425  }
1426 
1442  public function setFormIdentifier( $ident ) {
1443  $this->mFormIdentifier = $ident;
1444 
1445  return $this;
1446  }
1447 
1458  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1459  $this->mShowSubmit = !$suppressSubmit;
1460 
1461  return $this;
1462  }
1463 
1470  public function showCancel( $show = true ) {
1471  $this->mShowCancel = $show;
1472  return $this;
1473  }
1474 
1481  public function setCancelTarget( $target ) {
1482  $this->mCancelTarget = $target;
1483  return $this;
1484  }
1485 
1495  public function setTableId( $id ) {
1496  $this->mTableId = $id;
1497 
1498  return $this;
1499  }
1500 
1506  public function setId( $id ) {
1507  $this->mId = $id;
1508 
1509  return $this;
1510  }
1511 
1516  public function setName( $name ) {
1517  $this->mName = $name;
1518 
1519  return $this;
1520  }
1521 
1533  public function setWrapperLegend( $legend ) {
1534  $this->mWrapperLegend = $legend;
1535 
1536  return $this;
1537  }
1538 
1548  public function setWrapperLegendMsg( $msg ) {
1549  if ( !$msg instanceof Message ) {
1550  $msg = $this->msg( $msg );
1551  }
1552  $this->setWrapperLegend( $msg->text() );
1553 
1554  return $this;
1555  }
1556 
1566  public function setMessagePrefix( $p ) {
1567  $this->mMessagePrefix = $p;
1568 
1569  return $this;
1570  }
1571 
1579  public function setTitle( $t ) {
1580  $this->mTitle = $t;
1581 
1582  return $this;
1583  }
1584 
1589  public function getTitle() {
1590  return $this->mTitle === false
1591  ? $this->getContext()->getTitle()
1592  : $this->mTitle;
1593  }
1594 
1602  public function setMethod( $method = 'post' ) {
1603  $this->mMethod = strtolower( $method );
1604 
1605  return $this;
1606  }
1607 
1611  public function getMethod() {
1612  return $this->mMethod;
1613  }
1614 
1624  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1625  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1626  }
1627 
1644  public function displaySection( $fields,
1645  $sectionName = '',
1646  $fieldsetIDPrefix = '',
1647  &$hasUserVisibleFields = false
1648  ) {
1649  if ( $this->mFieldData === null ) {
1650  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1651  . 'You probably called displayForm() without calling prepareForm() first.' );
1652  }
1653 
1654  $displayFormat = $this->getDisplayFormat();
1655 
1656  $html = [];
1657  $subsectionHtml = '';
1658  $hasLabel = false;
1659 
1660  // Conveniently, PHP method names are case-insensitive.
1661  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1662  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1663 
1664  foreach ( $fields as $key => $value ) {
1665  if ( $value instanceof HTMLFormField ) {
1666  $v = array_key_exists( $key, $this->mFieldData )
1667  ? $this->mFieldData[$key]
1668  : $value->getDefault();
1669 
1670  $retval = $value->$getFieldHtmlMethod( $v );
1671 
1672  // check, if the form field should be added to
1673  // the output.
1674  if ( $value->hasVisibleOutput() ) {
1675  $html[] = $retval;
1676 
1677  $labelValue = trim( $value->getLabel() );
1678  if ( $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' && $labelValue !== '' ) {
1679  $hasLabel = true;
1680  }
1681 
1682  $hasUserVisibleFields = true;
1683  }
1684  } elseif ( is_array( $value ) ) {
1685  $subsectionHasVisibleFields = false;
1686  $section =
1687  $this->displaySection( $value,
1688  "mw-htmlform-$key",
1689  "$fieldsetIDPrefix$key-",
1690  $subsectionHasVisibleFields );
1691  $legend = null;
1692 
1693  if ( $subsectionHasVisibleFields === true ) {
1694  // Display the section with various niceties.
1695  $hasUserVisibleFields = true;
1696 
1697  $legend = $this->getLegend( $key );
1698 
1699  $section = $this->getHeaderText( $key ) .
1700  $section .
1701  $this->getFooterText( $key );
1702 
1703  $attributes = [];
1704  if ( $fieldsetIDPrefix ) {
1705  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1706  }
1707  $subsectionHtml .= $this->wrapFieldSetSection(
1708  $legend, $section, $attributes, $fields === $this->mFieldTree
1709  );
1710  } else {
1711  // Just return the inputs, nothing fancy.
1712  $subsectionHtml .= $section;
1713  }
1714  }
1715  }
1716 
1717  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1718 
1719  if ( $subsectionHtml ) {
1720  if ( $this->mSubSectionBeforeFields ) {
1721  return $subsectionHtml . "\n" . $html;
1722  } else {
1723  return $html . "\n" . $subsectionHtml;
1724  }
1725  } else {
1726  return $html;
1727  }
1728  }
1729 
1737  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1738  if ( !$fieldsHtml ) {
1739  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1740  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1741  return '';
1742  }
1743 
1744  $displayFormat = $this->getDisplayFormat();
1745  $html = implode( '', $fieldsHtml );
1746 
1747  if ( $displayFormat === 'raw' ) {
1748  return $html;
1749  }
1750 
1751  $classes = [];
1752 
1753  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1754  $classes[] = 'mw-htmlform-nolabel';
1755  }
1756 
1757  $attribs = [
1758  'class' => implode( ' ', $classes ),
1759  ];
1760 
1761  if ( $sectionName ) {
1762  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1763  }
1764 
1765  if ( $displayFormat === 'table' ) {
1766  return Html::rawElement( 'table',
1767  $attribs,
1768  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1769  } elseif ( $displayFormat === 'inline' ) {
1770  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1771  } else {
1772  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1773  }
1774  }
1775 
1779  public function loadData() {
1780  $fieldData = [];
1781 
1782  foreach ( $this->mFlatFields as $fieldname => $field ) {
1783  $request = $this->getRequest();
1784  if ( $field->skipLoadData( $request ) ) {
1785  continue;
1786  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1787  $fieldData[$fieldname] = $field->getDefault();
1788  } else {
1789  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1790  }
1791  }
1792 
1793  # Filter data.
1794  foreach ( $fieldData as $name => &$value ) {
1795  $field = $this->mFlatFields[$name];
1796  $value = $field->filter( $value, $this->mFlatFields );
1797  }
1798 
1799  $this->mFieldData = $fieldData;
1800  }
1801 
1809  public function suppressReset( $suppressReset = true ) {
1810  $this->mShowReset = !$suppressReset;
1811 
1812  return $this;
1813  }
1814 
1824  public function filterDataForSubmit( $data ) {
1825  return $data;
1826  }
1827 
1836  public function getLegend( $key ) {
1837  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1838  }
1839 
1850  public function setAction( $action ) {
1851  $this->mAction = $action;
1852 
1853  return $this;
1854  }
1855 
1863  public function getAction() {
1864  // If an action is alredy provided, return it
1865  if ( $this->mAction !== false ) {
1866  return $this->mAction;
1867  }
1868 
1869  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1870  // Check whether we are in GET mode and the ArticlePath contains a "?"
1871  // meaning that getLocalURL() would return something like "index.php?title=...".
1872  // As browser remove the query string before submitting GET forms,
1873  // it means that the title would be lost. In such case use wfScript() instead
1874  // and put title in an hidden field (see getHiddenFields()).
1875  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1876  return wfScript();
1877  }
1878 
1879  return $this->getTitle()->getLocalURL();
1880  }
1881 
1892  public function setAutocomplete( $autocomplete ) {
1893  $this->mAutocomplete = $autocomplete;
1894 
1895  return $this;
1896  }
1897 
1904  protected function getMessage( $value ) {
1905  return Message::newFromSpecifier( $value )->setContext( $this );
1906  }
1907 
1917  public function needsJSForHtml5FormValidation() {
1918  foreach ( $this->mFlatFields as $fieldname => $field ) {
1919  if ( $field->needsJSForHtml5FormValidation() ) {
1920  return true;
1921  }
1922  }
1923  return false;
1924  }
1925 }
HTMLFormField [] $mFlatFields
Definition: HTMLForm.php:183
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:585
string null $mAutocomplete
Form attribute autocomplete.
Definition: HTMLForm.php:227
needsJSForHtml5FormValidation()
Whether this form, with its current fields, requires the user agent to have JavaScript enabled for th...
Definition: HTMLForm.php:1917
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:1996
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: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:505
setSubmitID( $t)
Set the id for the submit button.
Definition: HTMLForm.php:1421
$mWasSubmitted
Definition: HTMLForm.php:213
static getClassFromDescriptor( $fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:452
setPostText( $msg)
Set text at the end of the display.
Definition: HTMLForm.php:897
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:597
$mWrapperLegend
Definition: HTMLForm.php:233
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1624
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:1863
setSubmitName( $name)
Definition: HTMLForm.php:1396
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1470
setFooterText( $msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:852
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:432
$mUseMultipart
Definition: HTMLForm.php:229
setTokenSalt( $salt)
Set the salt for the edit token.
Definition: HTMLForm.php:1002
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:830
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher...
Definition: HTMLForm.php:606
setSubmitTooltip( $name)
Definition: HTMLForm.php:1407
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1277
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
$mHiddenFields
Definition: HTMLForm.php:230
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:961
$value
getLegend( $key)
Get a string to go in the "<legend>" of a section fieldset.
Definition: HTMLForm.php:1836
hasField( $fieldname)
Definition: HTMLForm.php:371
displaySection( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1644
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:284
$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
setId( $id)
Definition: HTMLForm.php:1506
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:261
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:1994
getHiddenFields()
Get the hidden fields that should go inside the form.
Definition: HTMLForm.php:1108
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:239
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:929
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:1602
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
setSubmitProgressive()
Identify that the submit button in the form has a progressive action.
Definition: HTMLForm.php:1359
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: HTMLForm.php:480
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:309
displayForm( $submitResult)
Display the form (sending to the context&#39;s OutputPage object), with an appropriate error message or s...
Definition: HTMLForm.php:1020
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:255
setSubmitText( $t)
Set the text for the submit button.
Definition: HTMLForm.php:1333
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:567
static $mFieldData
Definition: HTMLForm.php:137
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1481
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:912
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1345
getHTML( $submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1032
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:1904
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:1289
setFormIdentifier( $ident)
Set an internal identifier for this form.
Definition: HTMLForm.php:1442
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:611
setTableId( $id)
Set the id of the <table> or outermost <div> element.
Definition: HTMLForm.php:1495
$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:1589
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:797
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:461
formatErrors( $errors)
Format a stack of error messages into a single HTML string.
Definition: HTMLForm.php:1310
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: HTMLForm.php:1090
getContext()
Get the base IContextSource object.
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1056
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:1996
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:1824
setValidationErrorMessage( $msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:710
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields&#39; HTML, merging it and wrapping.
Definition: HTMLForm.php:1737
array $availableSubclassDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:272
addPreText( $msg)
Add HTML to introductory message.
Definition: HTMLForm.php:750
setMessagePrefix( $p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1566
setSubmitCallback( $cb)
Set a callback to a function to do something with the form once it&#39;s been successfully validated...
Definition: HTMLForm.php:696
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1387
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:3043
$mCancelTarget
Definition: HTMLForm.php:190
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:682
$mFormIdentifier
Definition: HTMLForm.php:210
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:380
$mSectionFooters
Definition: HTMLForm.php:199
getPreText()
Get the introductory message HTML.
Definition: HTMLForm.php:763
$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:428
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:1779
setAction( $action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1850
suppressReset( $suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1809
getFooterText( $section=null)
Get footer text.
Definition: HTMLForm.php:869
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:795
getErrorsOrWarnings( $elements, $elementsType)
Returns a formatted list of errors or warnings from the given elements.
Definition: HTMLForm.php:1277
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getHeaderText( $section=null)
Get header text.
Definition: HTMLForm.php:814
getErrors( $errors)
Format and display an error message stack.
Definition: HTMLForm.php:1264
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:528
setIntro( $msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:723
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1374
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:276
$mSectionHeaders
Definition: HTMLForm.php:198
setAutocomplete( $autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1892
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element...
Definition: HTMLForm.php:1548
$mMessagePrefix
Definition: HTMLForm.php:180
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1251
setPreText( $msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:737
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1458
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2147
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:775
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1142
setDisplayFormat( $format)
Set format in which to display the form.
Definition: HTMLForm.php:397
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:2626
$mSubSectionBeforeFields
If true, sections that contain both fields and subsections will render their subsections before their...
Definition: HTMLForm.php:248
addPostText( $msg)
Add text to the end of the display.
Definition: HTMLForm.php:884
setName( $name)
Definition: HTMLForm.php:1516
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element...
Definition: HTMLForm.php:1533
setTitle( $t)
Set the title for form submission.
Definition: HTMLForm.php:1579