MediaWiki  master
HTMLForm.php
Go to the documentation of this file.
1 <?php
2 
25 
136 class HTMLForm extends ContextSource {
137  // A mapping of 'type' inputs onto standard HTMLFormField subclasses
138  public static $typeMappings = [
139  'api' => HTMLApiField::class,
141  'textwithbutton' => HTMLTextFieldWithButton::class,
142  'textarea' => HTMLTextAreaField::class,
143  'select' => HTMLSelectField::class,
144  'combobox' => HTMLComboboxField::class,
145  'radio' => HTMLRadioField::class,
146  'multiselect' => HTMLMultiSelectField::class,
147  'limitselect' => HTMLSelectLimitField::class,
148  'check' => HTMLCheckField::class,
149  'toggle' => HTMLCheckField::class,
150  'int' => HTMLIntField::class,
151  'float' => HTMLFloatField::class,
152  'info' => HTMLInfoField::class,
153  'selectorother' => HTMLSelectOrOtherField::class,
154  'selectandother' => HTMLSelectAndOtherField::class,
155  'namespaceselect' => HTMLSelectNamespace::class,
156  'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton::class,
157  'tagfilter' => HTMLTagFilter::class,
158  'sizefilter' => HTMLSizeFilterField::class,
159  'submit' => HTMLSubmitField::class,
160  'hidden' => HTMLHiddenField::class,
161  'edittools' => HTMLEditTools::class,
162  'checkmatrix' => HTMLCheckMatrix::class,
163  'cloner' => HTMLFormFieldCloner::class,
164  'autocompleteselect' => HTMLAutoCompleteSelectField::class,
165  'date' => HTMLDateTimeField::class,
166  'time' => HTMLDateTimeField::class,
167  'datetime' => HTMLDateTimeField::class,
168  'expiry' => HTMLExpiryField::class,
169  // HTMLTextField will output the correct type="" attribute automagically.
170  // There are about four zillion other HTML5 input types, like range, but
171  // we don't use those at the moment, so no point in adding all of them.
172  'email' => HTMLTextField::class,
173  'password' => HTMLTextField::class,
174  'url' => HTMLTextField::class,
175  'title' => HTMLTitleTextField::class,
176  'user' => HTMLUserTextField::class,
177  'usersmultiselect' => HTMLUsersMultiselectField::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 $mAutocomplete = null;
230 
231  protected $mUseMultipart = false;
232  protected $mHiddenFields = [];
233  protected $mButtons = [];
234 
235  protected $mWrapperLegend = false;
236 
241  protected $mTokenSalt = '';
242 
250  protected $mSubSectionBeforeFields = true;
251 
257  protected $displayFormat = 'table';
258 
264  'table',
265  'div',
266  'raw',
267  'inline',
268  ];
269 
275  'vform',
276  'ooui',
277  ];
278 
286  public static function factory( $displayFormat/*, $arguments...*/ ) {
287  $arguments = func_get_args();
288  array_shift( $arguments );
289 
290  switch ( $displayFormat ) {
291  case 'vform':
292  return ObjectFactory::constructClassInstance( VFormHTMLForm::class, $arguments );
293  case 'ooui':
294  return ObjectFactory::constructClassInstance( OOUIHTMLForm::class, $arguments );
295  default:
297  $form = ObjectFactory::constructClassInstance( self::class, $arguments );
298  $form->setDisplayFormat( $displayFormat );
299  return $form;
300  }
301  }
302 
311  public function __construct( $descriptor, /*IContextSource*/ $context = null,
312  $messagePrefix = ''
313  ) {
314  if ( $context instanceof IContextSource ) {
315  $this->setContext( $context );
316  $this->mTitle = false; // We don't need them to set a title
317  $this->mMessagePrefix = $messagePrefix;
318  } elseif ( $context === null && $messagePrefix !== '' ) {
319  $this->mMessagePrefix = $messagePrefix;
320  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
321  // B/C since 1.18
322  // it's actually $messagePrefix
323  $this->mMessagePrefix = $context;
324  }
325 
326  // Evil hack for mobile :(
327  if (
328  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
329  && $this->displayFormat === 'table'
330  ) {
331  $this->displayFormat = 'div';
332  }
333 
334  // Expand out into a tree.
335  $loadedDescriptor = [];
336  $this->mFlatFields = [];
337 
338  foreach ( $descriptor as $fieldname => $info ) {
339  $section = $info['section'] ?? '';
340 
341  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
342  $this->mUseMultipart = true;
343  }
344 
345  $field = static::loadInputFromParameters( $fieldname, $info, $this );
346 
347  $setSection =& $loadedDescriptor;
348  if ( $section ) {
349  $sectionParts = explode( '/', $section );
350 
351  while ( count( $sectionParts ) ) {
352  $newName = array_shift( $sectionParts );
353 
354  if ( !isset( $setSection[$newName] ) ) {
355  $setSection[$newName] = [];
356  }
357 
358  $setSection =& $setSection[$newName];
359  }
360  }
361 
362  $setSection[$fieldname] = $field;
363  $this->mFlatFields[$fieldname] = $field;
364  }
365 
366  $this->mFieldTree = $loadedDescriptor;
367  }
368 
373  public function hasField( $fieldname ) {
374  return isset( $this->mFlatFields[$fieldname] );
375  }
376 
382  public function getField( $fieldname ) {
383  if ( !$this->hasField( $fieldname ) ) {
384  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
385  }
386  return $this->mFlatFields[$fieldname];
387  }
388 
399  public function setDisplayFormat( $format ) {
400  if (
401  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
402  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
403  ) {
404  throw new MWException( 'Cannot change display format after creation, ' .
405  'use HTMLForm::factory() instead' );
406  }
407 
408  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
409  throw new MWException( 'Display format must be one of ' .
410  print_r(
411  array_merge(
412  $this->availableDisplayFormats,
413  $this->availableSubclassDisplayFormats
414  ),
415  true
416  ) );
417  }
418 
419  // Evil hack for mobile :(
420  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
421  $format = 'div';
422  }
423 
424  $this->displayFormat = $format;
425 
426  return $this;
427  }
428 
434  public function getDisplayFormat() {
435  return $this->displayFormat;
436  }
437 
454  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
455  if ( isset( $descriptor['class'] ) ) {
456  $class = $descriptor['class'];
457  } elseif ( isset( $descriptor['type'] ) ) {
458  $class = static::$typeMappings[$descriptor['type']];
459  $descriptor['class'] = $class;
460  } else {
461  $class = null;
462  }
463 
464  if ( !$class ) {
465  throw new MWException( "Descriptor with no class for $fieldname: "
466  . print_r( $descriptor, true ) );
467  }
468 
469  return $class;
470  }
471 
482  public static function loadInputFromParameters( $fieldname, $descriptor,
483  HTMLForm $parent = null
484  ) {
485  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
486 
487  $descriptor['fieldname'] = $fieldname;
488  if ( $parent ) {
489  $descriptor['parent'] = $parent;
490  }
491 
492  # @todo This will throw a fatal error whenever someone try to use
493  # 'class' to feed a CSS class instead of 'cssclass'. Would be
494  # great to avoid the fatal error and show a nice error.
495  return new $class( $descriptor );
496  }
497 
507  public function prepareForm() {
508  # Check if we have the info we need
509  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
510  throw new MWException( 'You must call setTitle() on an HTMLForm' );
511  }
512 
513  # Load data from the request.
514  if (
515  $this->mFormIdentifier === null ||
516  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
517  ) {
518  $this->loadData();
519  } else {
520  $this->mFieldData = [];
521  }
522 
523  return $this;
524  }
525 
530  public function tryAuthorizedSubmit() {
531  $result = false;
532 
533  $identOkay = false;
534  if ( $this->mFormIdentifier === null ) {
535  $identOkay = true;
536  } else {
537  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
538  }
539 
540  $tokenOkay = false;
541  if ( $this->getMethod() !== 'post' ) {
542  $tokenOkay = true; // no session check needed
543  } elseif ( $this->getRequest()->wasPosted() ) {
544  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
545  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
546  // Session tokens for logged-out users have no security value.
547  // However, if the user gave one, check it in order to give a nice
548  // "session expired" error instead of "permission denied" or such.
549  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
550  } else {
551  $tokenOkay = true;
552  }
553  }
554 
555  if ( $tokenOkay && $identOkay ) {
556  $this->mWasSubmitted = true;
557  $result = $this->trySubmit();
558  }
559 
560  return $result;
561  }
562 
569  public function show() {
570  $this->prepareForm();
571 
572  $result = $this->tryAuthorizedSubmit();
573  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
574  return $result;
575  }
576 
577  $this->displayForm( $result );
578 
579  return false;
580  }
581 
587  public function showAlways() {
588  $this->prepareForm();
589 
590  $result = $this->tryAuthorizedSubmit();
591 
592  $this->displayForm( $result );
593 
594  return $result;
595  }
596 
608  public function trySubmit() {
609  $valid = true;
610  $hoistedErrors = Status::newGood();
611  if ( $this->mValidationErrorMessage ) {
612  foreach ( (array)$this->mValidationErrorMessage as $error ) {
613  $hoistedErrors->fatal( ...$error );
614  }
615  } else {
616  $hoistedErrors->fatal( 'htmlform-invalid-input' );
617  }
618 
619  $this->mWasSubmitted = true;
620 
621  # Check for cancelled submission
622  foreach ( $this->mFlatFields as $fieldname => $field ) {
623  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
624  continue;
625  }
626  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
627  $this->mWasSubmitted = false;
628  return false;
629  }
630  }
631 
632  # Check for validation
633  foreach ( $this->mFlatFields as $fieldname => $field ) {
634  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
635  continue;
636  }
637  if ( $field->isHidden( $this->mFieldData ) ) {
638  continue;
639  }
640  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
641  if ( $res !== true ) {
642  $valid = false;
643  if ( $res !== false && !$field->canDisplayErrors() ) {
644  if ( is_string( $res ) ) {
645  $hoistedErrors->fatal( 'rawmessage', $res );
646  } else {
647  $hoistedErrors->fatal( $res );
648  }
649  }
650  }
651  }
652 
653  if ( !$valid ) {
654  return $hoistedErrors;
655  }
656 
657  $callback = $this->mSubmitCallback;
658  if ( !is_callable( $callback ) ) {
659  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
660  'setSubmitCallback() to set one.' );
661  }
662 
663  $data = $this->filterDataForSubmit( $this->mFieldData );
664 
665  $res = call_user_func( $callback, $data, $this );
666  if ( $res === false ) {
667  $this->mWasSubmitted = false;
668  }
669 
670  return $res;
671  }
672 
684  public function wasSubmitted() {
685  return $this->mWasSubmitted;
686  }
687 
698  public function setSubmitCallback( $cb ) {
699  $this->mSubmitCallback = $cb;
700 
701  return $this;
702  }
703 
712  public function setValidationErrorMessage( $msg ) {
713  $this->mValidationErrorMessage = $msg;
714 
715  return $this;
716  }
717 
725  public function setIntro( $msg ) {
726  $this->setPreText( $msg );
727 
728  return $this;
729  }
730 
739  public function setPreText( $msg ) {
740  $this->mPre = $msg;
741 
742  return $this;
743  }
744 
752  public function addPreText( $msg ) {
753  $this->mPre .= $msg;
754 
755  return $this;
756  }
757 
765  public function getPreText() {
766  return $this->mPre;
767  }
768 
777  public function addHeaderText( $msg, $section = null ) {
778  if ( $section === null ) {
779  $this->mHeader .= $msg;
780  } else {
781  if ( !isset( $this->mSectionHeaders[$section] ) ) {
782  $this->mSectionHeaders[$section] = '';
783  }
784  $this->mSectionHeaders[$section] .= $msg;
785  }
786 
787  return $this;
788  }
789 
799  public function setHeaderText( $msg, $section = null ) {
800  if ( $section === null ) {
801  $this->mHeader = $msg;
802  } else {
803  $this->mSectionHeaders[$section] = $msg;
804  }
805 
806  return $this;
807  }
808 
816  public function getHeaderText( $section = null ) {
817  if ( $section === null ) {
818  return $this->mHeader;
819  } else {
820  return $this->mSectionHeaders[$section] ?? '';
821  }
822  }
823 
832  public function addFooterText( $msg, $section = null ) {
833  if ( $section === null ) {
834  $this->mFooter .= $msg;
835  } else {
836  if ( !isset( $this->mSectionFooters[$section] ) ) {
837  $this->mSectionFooters[$section] = '';
838  }
839  $this->mSectionFooters[$section] .= $msg;
840  }
841 
842  return $this;
843  }
844 
854  public function setFooterText( $msg, $section = null ) {
855  if ( $section === null ) {
856  $this->mFooter = $msg;
857  } else {
858  $this->mSectionFooters[$section] = $msg;
859  }
860 
861  return $this;
862  }
863 
871  public function getFooterText( $section = null ) {
872  if ( $section === null ) {
873  return $this->mFooter;
874  } else {
875  return $this->mSectionFooters[$section] ?? '';
876  }
877  }
878 
886  public function addPostText( $msg ) {
887  $this->mPost .= $msg;
888 
889  return $this;
890  }
891 
899  public function setPostText( $msg ) {
900  $this->mPost = $msg;
901 
902  return $this;
903  }
904 
914  public function addHiddenField( $name, $value, array $attribs = [] ) {
915  $attribs += [ 'name' => $name ];
916  $this->mHiddenFields[] = [ $value, $attribs ];
917 
918  return $this;
919  }
920 
931  public function addHiddenFields( array $fields ) {
932  foreach ( $fields as $name => $value ) {
933  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
934  }
935 
936  return $this;
937  }
938 
963  public function addButton( $data ) {
964  if ( !is_array( $data ) ) {
965  $args = func_get_args();
966  if ( count( $args ) < 2 || count( $args ) > 4 ) {
967  throw new InvalidArgumentException(
968  'Incorrect number of arguments for deprecated calling style'
969  );
970  }
971  $data = [
972  'name' => $args[0],
973  'value' => $args[1],
974  'id' => $args[2] ?? null,
975  'attribs' => $args[3] ?? null,
976  ];
977  } else {
978  if ( !isset( $data['name'] ) ) {
979  throw new InvalidArgumentException( 'A name is required' );
980  }
981  if ( !isset( $data['value'] ) ) {
982  throw new InvalidArgumentException( 'A value is required' );
983  }
984  }
985  $this->mButtons[] = $data + [
986  'id' => null,
987  'attribs' => null,
988  'flags' => null,
989  'framed' => true,
990  ];
991 
992  return $this;
993  }
994 
1004  public function setTokenSalt( $salt ) {
1005  $this->mTokenSalt = $salt;
1006 
1007  return $this;
1008  }
1009 
1022  public function displayForm( $submitResult ) {
1023  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1024  }
1025 
1034  public function getHTML( $submitResult ) {
1035  # For good measure (it is the default)
1036  $this->getOutput()->preventClickjacking();
1037  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1038  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1039 
1040  $html = ''
1041  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1042  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1043  . $this->getHeaderText()
1044  . $this->getBody()
1045  . $this->getHiddenFields()
1046  . $this->getButtons()
1047  . $this->getFooterText();
1048 
1049  $html = $this->wrapForm( $html );
1050 
1051  return '' . $this->mPre . $html . $this->mPost;
1052  }
1053 
1058  protected function getFormAttributes() {
1059  # Use multipart/form-data
1060  $encType = $this->mUseMultipart
1061  ? 'multipart/form-data'
1062  : 'application/x-www-form-urlencoded';
1063  # Attributes
1064  $attribs = [
1065  'class' => 'mw-htmlform',
1066  'action' => $this->getAction(),
1067  'method' => $this->getMethod(),
1068  'enctype' => $encType,
1069  ];
1070  if ( $this->mId ) {
1071  $attribs['id'] = $this->mId;
1072  }
1073  if ( is_string( $this->mAutocomplete ) ) {
1074  $attribs['autocomplete'] = $this->mAutocomplete;
1075  }
1076  if ( $this->mName ) {
1077  $attribs['name'] = $this->mName;
1078  }
1079  if ( $this->needsJSForHtml5FormValidation() ) {
1080  $attribs['novalidate'] = true;
1081  }
1082  return $attribs;
1083  }
1084 
1092  public function wrapForm( $html ) {
1093  # Include a <fieldset> wrapper for style, if requested.
1094  if ( $this->mWrapperLegend !== false ) {
1095  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1096  $html = Xml::fieldset( $legend, $html );
1097  }
1098 
1099  return Html::rawElement(
1100  'form',
1101  $this->getFormAttributes(),
1102  $html
1103  );
1104  }
1105 
1110  public function getHiddenFields() {
1111  $html = '';
1112  if ( $this->mFormIdentifier !== null ) {
1113  $html .= Html::hidden(
1114  'wpFormIdentifier',
1115  $this->mFormIdentifier
1116  ) . "\n";
1117  }
1118  if ( $this->getMethod() === 'post' ) {
1119  $html .= Html::hidden(
1120  'wpEditToken',
1121  $this->getUser()->getEditToken( $this->mTokenSalt ),
1122  [ 'id' => 'wpEditToken' ]
1123  ) . "\n";
1124  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1125  }
1126 
1127  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1128  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1129  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1130  }
1131 
1132  foreach ( $this->mHiddenFields as $data ) {
1133  list( $value, $attribs ) = $data;
1134  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1135  }
1136 
1137  return $html;
1138  }
1139 
1144  public function getButtons() {
1145  $buttons = '';
1146  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1147 
1148  if ( $this->mShowSubmit ) {
1149  $attribs = [];
1150 
1151  if ( isset( $this->mSubmitID ) ) {
1152  $attribs['id'] = $this->mSubmitID;
1153  }
1154 
1155  if ( isset( $this->mSubmitName ) ) {
1156  $attribs['name'] = $this->mSubmitName;
1157  }
1158 
1159  if ( isset( $this->mSubmitTooltip ) ) {
1160  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1161  }
1162 
1163  $attribs['class'] = [ 'mw-htmlform-submit' ];
1164 
1165  if ( $useMediaWikiUIEverywhere ) {
1166  foreach ( $this->mSubmitFlags as $flag ) {
1167  $attribs['class'][] = 'mw-ui-' . $flag;
1168  }
1169  $attribs['class'][] = 'mw-ui-button';
1170  }
1171 
1172  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1173  }
1174 
1175  if ( $this->mShowReset ) {
1176  $buttons .= Html::element(
1177  'input',
1178  [
1179  'type' => 'reset',
1180  'value' => $this->msg( 'htmlform-reset' )->text(),
1181  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1182  ]
1183  ) . "\n";
1184  }
1185 
1186  if ( $this->mShowCancel ) {
1187  $target = $this->mCancelTarget ?: Title::newMainPage();
1188  if ( $target instanceof Title ) {
1189  $target = $target->getLocalURL();
1190  }
1191  $buttons .= Html::element(
1192  'a',
1193  [
1194  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1195  'href' => $target,
1196  ],
1197  $this->msg( 'cancel' )->text()
1198  ) . "\n";
1199  }
1200 
1201  // IE<8 has bugs with <button>, so we'll need to avoid them.
1202  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1203 
1204  foreach ( $this->mButtons as $button ) {
1205  $attrs = [
1206  'type' => 'submit',
1207  'name' => $button['name'],
1208  'value' => $button['value']
1209  ];
1210 
1211  if ( isset( $button['label-message'] ) ) {
1212  $label = $this->getMessage( $button['label-message'] )->parse();
1213  } elseif ( isset( $button['label'] ) ) {
1214  $label = htmlspecialchars( $button['label'] );
1215  } elseif ( isset( $button['label-raw'] ) ) {
1216  $label = $button['label-raw'];
1217  } else {
1218  $label = htmlspecialchars( $button['value'] );
1219  }
1220 
1221  if ( $button['attribs'] ) {
1222  $attrs += $button['attribs'];
1223  }
1224 
1225  if ( isset( $button['id'] ) ) {
1226  $attrs['id'] = $button['id'];
1227  }
1228 
1229  if ( $useMediaWikiUIEverywhere ) {
1230  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1231  $attrs['class'][] = 'mw-ui-button';
1232  }
1233 
1234  if ( $isBadIE ) {
1235  $buttons .= Html::element( 'input', $attrs ) . "\n";
1236  } else {
1237  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1238  }
1239  }
1240 
1241  if ( !$buttons ) {
1242  return '';
1243  }
1244 
1245  return Html::rawElement( 'span',
1246  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1247  }
1248 
1253  public function getBody() {
1254  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1255  }
1256 
1266  public function getErrors( $errors ) {
1267  wfDeprecated( __METHOD__ );
1268  return $this->getErrorsOrWarnings( $errors, 'error' );
1269  }
1270 
1279  public function getErrorsOrWarnings( $elements, $elementsType ) {
1280  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1281  throw new DomainException( $elementsType . ' is not a valid type.' );
1282  }
1283  $elementstr = false;
1284  if ( $elements instanceof Status ) {
1285  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1286  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1287  if ( $status->isGood() ) {
1288  $elementstr = '';
1289  } else {
1290  $elementstr = $this->getOutput()->parse(
1291  $status->getWikiText()
1292  );
1293  }
1294  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1295  $elementstr = $this->formatErrors( $elements );
1296  } elseif ( $elementsType === 'error' ) {
1297  $elementstr = $elements;
1298  }
1299 
1300  return $elementstr
1301  ? Html::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1302  : '';
1303  }
1304 
1312  public function formatErrors( $errors ) {
1313  $errorstr = '';
1314 
1315  foreach ( $errors as $error ) {
1316  $errorstr .= Html::rawElement(
1317  'li',
1318  [],
1319  $this->getMessage( $error )->parse()
1320  );
1321  }
1322 
1323  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1324 
1325  return $errorstr;
1326  }
1327 
1335  public function setSubmitText( $t ) {
1336  $this->mSubmitText = $t;
1337 
1338  return $this;
1339  }
1340 
1347  public function setSubmitDestructive() {
1348  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1349 
1350  return $this;
1351  }
1352 
1361  public function setSubmitProgressive() {
1362  wfDeprecated( __METHOD__, '1.32' );
1363  $this->mSubmitFlags = [ 'progressive', 'primary' ];
1364 
1365  return $this;
1366  }
1367 
1376  public function setSubmitTextMsg( $msg ) {
1377  if ( !$msg instanceof Message ) {
1378  $msg = $this->msg( $msg );
1379  }
1380  $this->setSubmitText( $msg->text() );
1381 
1382  return $this;
1383  }
1384 
1389  public function getSubmitText() {
1390  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1391  }
1392 
1398  public function setSubmitName( $name ) {
1399  $this->mSubmitName = $name;
1400 
1401  return $this;
1402  }
1403 
1409  public function setSubmitTooltip( $name ) {
1410  $this->mSubmitTooltip = $name;
1411 
1412  return $this;
1413  }
1414 
1423  public function setSubmitID( $t ) {
1424  $this->mSubmitID = $t;
1425 
1426  return $this;
1427  }
1428 
1444  public function setFormIdentifier( $ident ) {
1445  $this->mFormIdentifier = $ident;
1446 
1447  return $this;
1448  }
1449 
1460  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1461  $this->mShowSubmit = !$suppressSubmit;
1462 
1463  return $this;
1464  }
1465 
1472  public function showCancel( $show = true ) {
1473  $this->mShowCancel = $show;
1474  return $this;
1475  }
1476 
1483  public function setCancelTarget( $target ) {
1484  $this->mCancelTarget = $target;
1485  return $this;
1486  }
1487 
1497  public function setTableId( $id ) {
1498  $this->mTableId = $id;
1499 
1500  return $this;
1501  }
1502 
1508  public function setId( $id ) {
1509  $this->mId = $id;
1510 
1511  return $this;
1512  }
1513 
1518  public function setName( $name ) {
1519  $this->mName = $name;
1520 
1521  return $this;
1522  }
1523 
1535  public function setWrapperLegend( $legend ) {
1536  $this->mWrapperLegend = $legend;
1537 
1538  return $this;
1539  }
1540 
1550  public function setWrapperLegendMsg( $msg ) {
1551  if ( !$msg instanceof Message ) {
1552  $msg = $this->msg( $msg );
1553  }
1554  $this->setWrapperLegend( $msg->text() );
1555 
1556  return $this;
1557  }
1558 
1568  public function setMessagePrefix( $p ) {
1569  $this->mMessagePrefix = $p;
1570 
1571  return $this;
1572  }
1573 
1581  public function setTitle( $t ) {
1582  $this->mTitle = $t;
1583 
1584  return $this;
1585  }
1586 
1591  public function getTitle() {
1592  return $this->mTitle === false
1593  ? $this->getContext()->getTitle()
1594  : $this->mTitle;
1595  }
1596 
1604  public function setMethod( $method = 'post' ) {
1605  $this->mMethod = strtolower( $method );
1606 
1607  return $this;
1608  }
1609 
1613  public function getMethod() {
1614  return $this->mMethod;
1615  }
1616 
1626  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1627  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1628  }
1629 
1646  public function displaySection( $fields,
1647  $sectionName = '',
1648  $fieldsetIDPrefix = '',
1649  &$hasUserVisibleFields = false
1650  ) {
1651  if ( $this->mFieldData === null ) {
1652  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1653  . 'You probably called displayForm() without calling prepareForm() first.' );
1654  }
1655 
1656  $displayFormat = $this->getDisplayFormat();
1657 
1658  $html = [];
1659  $subsectionHtml = '';
1660  $hasLabel = false;
1661 
1662  // Conveniently, PHP method names are case-insensitive.
1663  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1664  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1665 
1666  foreach ( $fields as $key => $value ) {
1667  if ( $value instanceof HTMLFormField ) {
1668  $v = array_key_exists( $key, $this->mFieldData )
1669  ? $this->mFieldData[$key]
1670  : $value->getDefault();
1671 
1672  $retval = $value->$getFieldHtmlMethod( $v );
1673 
1674  // check, if the form field should be added to
1675  // the output.
1676  if ( $value->hasVisibleOutput() ) {
1677  $html[] = $retval;
1678 
1679  $labelValue = trim( $value->getLabel() );
1680  if ( $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' && $labelValue !== '' ) {
1681  $hasLabel = true;
1682  }
1683 
1684  $hasUserVisibleFields = true;
1685  }
1686  } elseif ( is_array( $value ) ) {
1687  $subsectionHasVisibleFields = false;
1688  $section =
1689  $this->displaySection( $value,
1690  "mw-htmlform-$key",
1691  "$fieldsetIDPrefix$key-",
1692  $subsectionHasVisibleFields );
1693  $legend = null;
1694 
1695  if ( $subsectionHasVisibleFields === true ) {
1696  // Display the section with various niceties.
1697  $hasUserVisibleFields = true;
1698 
1699  $legend = $this->getLegend( $key );
1700 
1701  $section = $this->getHeaderText( $key ) .
1702  $section .
1703  $this->getFooterText( $key );
1704 
1705  $attributes = [];
1706  if ( $fieldsetIDPrefix ) {
1707  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1708  }
1709  $subsectionHtml .= $this->wrapFieldSetSection(
1710  $legend, $section, $attributes, $fields === $this->mFieldTree
1711  );
1712  } else {
1713  // Just return the inputs, nothing fancy.
1714  $subsectionHtml .= $section;
1715  }
1716  }
1717  }
1718 
1719  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1720 
1721  if ( $subsectionHtml ) {
1722  if ( $this->mSubSectionBeforeFields ) {
1723  return $subsectionHtml . "\n" . $html;
1724  } else {
1725  return $html . "\n" . $subsectionHtml;
1726  }
1727  } else {
1728  return $html;
1729  }
1730  }
1731 
1739  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1740  if ( !$fieldsHtml ) {
1741  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1742  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1743  return '';
1744  }
1745 
1746  $displayFormat = $this->getDisplayFormat();
1747  $html = implode( '', $fieldsHtml );
1748 
1749  if ( $displayFormat === 'raw' ) {
1750  return $html;
1751  }
1752 
1753  $classes = [];
1754 
1755  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1756  $classes[] = 'mw-htmlform-nolabel';
1757  }
1758 
1759  $attribs = [
1760  'class' => implode( ' ', $classes ),
1761  ];
1762 
1763  if ( $sectionName ) {
1764  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1765  }
1766 
1767  if ( $displayFormat === 'table' ) {
1768  return Html::rawElement( 'table',
1769  $attribs,
1770  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1771  } elseif ( $displayFormat === 'inline' ) {
1772  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1773  } else {
1774  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1775  }
1776  }
1777 
1781  public function loadData() {
1782  $fieldData = [];
1783 
1784  foreach ( $this->mFlatFields as $fieldname => $field ) {
1785  $request = $this->getRequest();
1786  if ( $field->skipLoadData( $request ) ) {
1787  continue;
1788  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1789  $fieldData[$fieldname] = $field->getDefault();
1790  } else {
1791  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1792  }
1793  }
1794 
1795  # Filter data.
1796  foreach ( $fieldData as $name => &$value ) {
1797  $field = $this->mFlatFields[$name];
1798  $value = $field->filter( $value, $this->mFlatFields );
1799  }
1800 
1801  $this->mFieldData = $fieldData;
1802  }
1803 
1811  public function suppressReset( $suppressReset = true ) {
1812  $this->mShowReset = !$suppressReset;
1813 
1814  return $this;
1815  }
1816 
1826  public function filterDataForSubmit( $data ) {
1827  return $data;
1828  }
1829 
1838  public function getLegend( $key ) {
1839  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1840  }
1841 
1852  public function setAction( $action ) {
1853  $this->mAction = $action;
1854 
1855  return $this;
1856  }
1857 
1865  public function getAction() {
1866  // If an action is alredy provided, return it
1867  if ( $this->mAction !== false ) {
1868  return $this->mAction;
1869  }
1870 
1871  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1872  // Check whether we are in GET mode and the ArticlePath contains a "?"
1873  // meaning that getLocalURL() would return something like "index.php?title=...".
1874  // As browser remove the query string before submitting GET forms,
1875  // it means that the title would be lost. In such case use wfScript() instead
1876  // and put title in an hidden field (see getHiddenFields()).
1877  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1878  return wfScript();
1879  }
1880 
1881  return $this->getTitle()->getLocalURL();
1882  }
1883 
1894  public function setAutocomplete( $autocomplete ) {
1895  $this->mAutocomplete = $autocomplete;
1896 
1897  return $this;
1898  }
1899 
1906  protected function getMessage( $value ) {
1907  return Message::newFromSpecifier( $value )->setContext( $this );
1908  }
1909 
1919  public function needsJSForHtml5FormValidation() {
1920  foreach ( $this->mFlatFields as $fieldname => $field ) {
1921  if ( $field->needsJSForHtml5FormValidation() ) {
1922  return true;
1923  }
1924  }
1925  return false;
1926  }
1927 }
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:587
string null $mAutocomplete
Form attribute autocomplete.
Definition: HTMLForm.php:229
needsJSForHtml5FormValidation()
Whether this form, with its current fields, requires the user agent to have JavaScript enabled for th...
Definition: HTMLForm.php:1919
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:2037
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:138
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:507
setSubmitID( $t)
Set the id for the submit button.
Definition: HTMLForm.php:1423
$mWasSubmitted
Definition: HTMLForm.php:215
static getClassFromDescriptor( $fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:454
setPostText( $msg)
Set text at the end of the display.
Definition: HTMLForm.php:899
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:597
$mWrapperLegend
Definition: HTMLForm.php:235
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1626
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:1865
setSubmitName( $name)
Definition: HTMLForm.php:1398
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1472
setFooterText( $msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:854
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:434
$mUseMultipart
Definition: HTMLForm.php:231
setTokenSalt( $salt)
Set the salt for the edit token.
Definition: HTMLForm.php:1004
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:832
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher...
Definition: HTMLForm.php:608
setSubmitTooltip( $name)
Definition: HTMLForm.php:1409
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:1305
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
$mHiddenFields
Definition: HTMLForm.php:232
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:963
$value
getLegend( $key)
Get a string to go in the "<legend>" of a section fieldset.
Definition: HTMLForm.php:1838
hasField( $fieldname)
Definition: HTMLForm.php:373
displaySection( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1646
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:286
$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:1508
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:263
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED 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:2035
getHiddenFields()
Get the hidden fields that should go inside the form.
Definition: HTMLForm.php:1110
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:241
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:931
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:1604
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:1361
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: HTMLForm.php:482
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:311
displayForm( $submitResult)
Display the form (sending to the context&#39;s OutputPage object), with an appropriate error message or s...
Definition: HTMLForm.php:1022
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:257
setSubmitText( $t)
Set the text for the submit button.
Definition: HTMLForm.php:1335
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:569
static $mFieldData
Definition: HTMLForm.php:140
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1483
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:914
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1347
getHTML( $submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1034
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:1906
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:1270
setFormIdentifier( $ident)
Set an internal identifier for this form.
Definition: HTMLForm.php:1444
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:1497
$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:1591
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:799
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:1312
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: HTMLForm.php:1092
getContext()
Get the base IContextSource object.
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1058
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:2037
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:1826
setValidationErrorMessage( $msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:712
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields&#39; HTML, merging it and wrapping.
Definition: HTMLForm.php:1739
array $availableSubclassDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:274
addPreText( $msg)
Add HTML to introductory message.
Definition: HTMLForm.php:752
setMessagePrefix( $p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1568
setSubmitCallback( $cb)
Set a callback to a function to do something with the form once it&#39;s been successfully validated...
Definition: HTMLForm.php:698
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1389
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:3091
$mCancelTarget
Definition: HTMLForm.php:192
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:684
$mFormIdentifier
Definition: HTMLForm.php:212
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:382
$mSectionFooters
Definition: HTMLForm.php:201
getPreText()
Get the introductory message HTML.
Definition: HTMLForm.php:765
$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:415
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:1781
setAction( $action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1852
suppressReset( $suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1811
getFooterText( $section=null)
Get footer text.
Definition: HTMLForm.php:871
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:1279
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getHeaderText( $section=null)
Get header text.
Definition: HTMLForm.php:816
getErrors( $errors)
Format and display an error message stack.
Definition: HTMLForm.php:1266
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:530
setIntro( $msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:725
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1376
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
$mSectionHeaders
Definition: HTMLForm.php:200
setAutocomplete( $autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1894
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element...
Definition: HTMLForm.php:1550
$mMessagePrefix
Definition: HTMLForm.php:182
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1253
setPreText( $msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:739
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1460
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2133
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:777
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1144
setDisplayFormat( $format)
Set format in which to display the form.
Definition: HTMLForm.php:399
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
Definition: hooks.txt:244
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2676
$mSubSectionBeforeFields
If true, sections that contain both fields and subsections will render their subsections before their...
Definition: HTMLForm.php:250
addPostText( $msg)
Add text to the end of the display.
Definition: HTMLForm.php:886
setName( $name)
Definition: HTMLForm.php:1518
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element...
Definition: HTMLForm.php:1535
setTitle( $t)
Set the title for form submission.
Definition: HTMLForm.php:1581