MediaWiki  master
HTMLForm.php
Go to the documentation of this file.
1 <?php
2 
25 
133 class HTMLForm extends ContextSource {
134  // A mapping of 'type' inputs onto standard HTMLFormField subclasses
135  public static $typeMappings = [
136  'api' => HTMLApiField::class,
138  'textwithbutton' => HTMLTextFieldWithButton::class,
139  'textarea' => HTMLTextAreaField::class,
140  'select' => HTMLSelectField::class,
141  'combobox' => HTMLComboboxField::class,
142  'radio' => HTMLRadioField::class,
143  'multiselect' => HTMLMultiSelectField::class,
144  'limitselect' => HTMLSelectLimitField::class,
145  'check' => HTMLCheckField::class,
146  'toggle' => HTMLCheckField::class,
147  'int' => HTMLIntField::class,
148  'float' => HTMLFloatField::class,
149  'info' => HTMLInfoField::class,
150  'selectorother' => HTMLSelectOrOtherField::class,
151  'selectandother' => HTMLSelectAndOtherField::class,
152  'namespaceselect' => HTMLSelectNamespace::class,
153  'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton::class,
154  'tagfilter' => HTMLTagFilter::class,
155  'sizefilter' => HTMLSizeFilterField::class,
156  'submit' => HTMLSubmitField::class,
157  'hidden' => HTMLHiddenField::class,
158  'edittools' => HTMLEditTools::class,
159  'checkmatrix' => HTMLCheckMatrix::class,
160  'cloner' => HTMLFormFieldCloner::class,
161  'autocompleteselect' => HTMLAutoCompleteSelectField::class,
162  'date' => HTMLDateTimeField::class,
163  'time' => HTMLDateTimeField::class,
164  'datetime' => HTMLDateTimeField::class,
165  'expiry' => HTMLExpiryField::class,
166  // HTMLTextField will output the correct type="" attribute automagically.
167  // There are about four zillion other HTML5 input types, like range, but
168  // we don't use those at the moment, so no point in adding all of them.
169  'email' => HTMLTextField::class,
170  'password' => HTMLTextField::class,
171  'url' => HTMLTextField::class,
172  'title' => HTMLTitleTextField::class,
173  'user' => HTMLUserTextField::class,
174  'usersmultiselect' => HTMLUsersMultiselectField::class,
175  ];
176 
177  public $mFieldData;
178 
179  protected $mMessagePrefix;
180 
182  protected $mFlatFields;
183 
184  protected $mFieldTree;
185  protected $mShowReset = false;
186  protected $mShowSubmit = true;
187  protected $mSubmitFlags = [ 'primary', 'progressive' ];
188  protected $mShowCancel = false;
189  protected $mCancelTarget;
190 
191  protected $mSubmitCallback;
193 
194  protected $mPre = '';
195  protected $mHeader = '';
196  protected $mFooter = '';
197  protected $mSectionHeaders = [];
198  protected $mSectionFooters = [];
199  protected $mPost = '';
200  protected $mId;
201  protected $mName;
202  protected $mTableId = '';
203 
204  protected $mSubmitID;
205  protected $mSubmitName;
206  protected $mSubmitText;
207  protected $mSubmitTooltip;
208 
209  protected $mFormIdentifier;
210  protected $mTitle;
211  protected $mMethod = 'post';
212  protected $mWasSubmitted = false;
213 
219  protected $mAction = false;
220 
226  protected $mAutocomplete = null;
227 
228  protected $mUseMultipart = false;
229  protected $mHiddenFields = [];
230  protected $mButtons = [];
231 
232  protected $mWrapperLegend = false;
233 
238  protected $mTokenSalt = '';
239 
247  protected $mSubSectionBeforeFields = true;
248 
254  protected $displayFormat = 'table';
255 
261  'table',
262  'div',
263  'raw',
264  'inline',
265  ];
266 
272  'vform',
273  'ooui',
274  ];
275 
283  public static function factory( $displayFormat/*, $arguments...*/ ) {
284  $arguments = func_get_args();
285  array_shift( $arguments );
286 
287  switch ( $displayFormat ) {
288  case 'vform':
289  return ObjectFactory::constructClassInstance( VFormHTMLForm::class, $arguments );
290  case 'ooui':
291  return ObjectFactory::constructClassInstance( OOUIHTMLForm::class, $arguments );
292  default:
294  $form = ObjectFactory::constructClassInstance( self::class, $arguments );
295  $form->setDisplayFormat( $displayFormat );
296  return $form;
297  }
298  }
299 
308  public function __construct( $descriptor, /*IContextSource*/ $context = null,
309  $messagePrefix = ''
310  ) {
311  if ( $context instanceof IContextSource ) {
312  $this->setContext( $context );
313  $this->mTitle = false; // We don't need them to set a title
314  $this->mMessagePrefix = $messagePrefix;
315  } elseif ( $context === null && $messagePrefix !== '' ) {
316  $this->mMessagePrefix = $messagePrefix;
317  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
318  // B/C since 1.18
319  // it's actually $messagePrefix
320  $this->mMessagePrefix = $context;
321  }
322 
323  // Evil hack for mobile :(
324  if (
325  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
326  && $this->displayFormat === 'table'
327  ) {
328  $this->displayFormat = 'div';
329  }
330 
331  // Expand out into a tree.
332  $loadedDescriptor = [];
333  $this->mFlatFields = [];
334 
335  foreach ( $descriptor as $fieldname => $info ) {
336  $section = $info['section'] ?? '';
337 
338  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
339  $this->mUseMultipart = true;
340  }
341 
342  $field = static::loadInputFromParameters( $fieldname, $info, $this );
343 
344  $setSection =& $loadedDescriptor;
345  if ( $section ) {
346  $sectionParts = explode( '/', $section );
347 
348  while ( count( $sectionParts ) ) {
349  $newName = array_shift( $sectionParts );
350 
351  if ( !isset( $setSection[$newName] ) ) {
352  $setSection[$newName] = [];
353  }
354 
355  $setSection =& $setSection[$newName];
356  }
357  }
358 
359  $setSection[$fieldname] = $field;
360  $this->mFlatFields[$fieldname] = $field;
361  }
362 
363  $this->mFieldTree = $loadedDescriptor;
364  }
365 
370  public function hasField( $fieldname ) {
371  return isset( $this->mFlatFields[$fieldname] );
372  }
373 
379  public function getField( $fieldname ) {
380  if ( !$this->hasField( $fieldname ) ) {
381  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
382  }
383  return $this->mFlatFields[$fieldname];
384  }
385 
396  public function setDisplayFormat( $format ) {
397  if (
398  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
399  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
400  ) {
401  throw new MWException( 'Cannot change display format after creation, ' .
402  'use HTMLForm::factory() instead' );
403  }
404 
405  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
406  throw new MWException( 'Display format must be one of ' .
407  print_r(
408  array_merge(
409  $this->availableDisplayFormats,
410  $this->availableSubclassDisplayFormats
411  ),
412  true
413  ) );
414  }
415 
416  // Evil hack for mobile :(
417  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
418  $format = 'div';
419  }
420 
421  $this->displayFormat = $format;
422 
423  return $this;
424  }
425 
431  public function getDisplayFormat() {
432  return $this->displayFormat;
433  }
434 
451  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
452  if ( isset( $descriptor['class'] ) ) {
453  $class = $descriptor['class'];
454  } elseif ( isset( $descriptor['type'] ) ) {
455  $class = static::$typeMappings[$descriptor['type']];
456  $descriptor['class'] = $class;
457  } else {
458  $class = null;
459  }
460 
461  if ( !$class ) {
462  throw new MWException( "Descriptor with no class for $fieldname: "
463  . print_r( $descriptor, true ) );
464  }
465 
466  return $class;
467  }
468 
479  public static function loadInputFromParameters( $fieldname, $descriptor,
480  HTMLForm $parent = null
481  ) {
482  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
483 
484  $descriptor['fieldname'] = $fieldname;
485  if ( $parent ) {
486  $descriptor['parent'] = $parent;
487  }
488 
489  # @todo This will throw a fatal error whenever someone try to use
490  # 'class' to feed a CSS class instead of 'cssclass'. Would be
491  # great to avoid the fatal error and show a nice error.
492  return new $class( $descriptor );
493  }
494 
504  public function prepareForm() {
505  # Check if we have the info we need
506  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
507  throw new MWException( 'You must call setTitle() on an HTMLForm' );
508  }
509 
510  # Load data from the request.
511  if (
512  $this->mFormIdentifier === null ||
513  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
514  ) {
515  $this->loadData();
516  } else {
517  $this->mFieldData = [];
518  }
519 
520  return $this;
521  }
522 
527  public function tryAuthorizedSubmit() {
528  $result = false;
529 
530  $identOkay = false;
531  if ( $this->mFormIdentifier === null ) {
532  $identOkay = true;
533  } else {
534  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
535  }
536 
537  $tokenOkay = false;
538  if ( $this->getMethod() !== 'post' ) {
539  $tokenOkay = true; // no session check needed
540  } elseif ( $this->getRequest()->wasPosted() ) {
541  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
542  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
543  // Session tokens for logged-out users have no security value.
544  // However, if the user gave one, check it in order to give a nice
545  // "session expired" error instead of "permission denied" or such.
546  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
547  } else {
548  $tokenOkay = true;
549  }
550  }
551 
552  if ( $tokenOkay && $identOkay ) {
553  $this->mWasSubmitted = true;
554  $result = $this->trySubmit();
555  }
556 
557  return $result;
558  }
559 
566  public function show() {
567  $this->prepareForm();
568 
569  $result = $this->tryAuthorizedSubmit();
570  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
571  return $result;
572  }
573 
574  $this->displayForm( $result );
575 
576  return false;
577  }
578 
584  public function showAlways() {
585  $this->prepareForm();
586 
587  $result = $this->tryAuthorizedSubmit();
588 
589  $this->displayForm( $result );
590 
591  return $result;
592  }
593 
605  public function trySubmit() {
606  $valid = true;
607  $hoistedErrors = Status::newGood();
608  if ( $this->mValidationErrorMessage ) {
609  foreach ( (array)$this->mValidationErrorMessage as $error ) {
610  $hoistedErrors->fatal( ...$error );
611  }
612  } else {
613  $hoistedErrors->fatal( 'htmlform-invalid-input' );
614  }
615 
616  $this->mWasSubmitted = true;
617 
618  # Check for cancelled submission
619  foreach ( $this->mFlatFields as $fieldname => $field ) {
620  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
621  continue;
622  }
623  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
624  $this->mWasSubmitted = false;
625  return false;
626  }
627  }
628 
629  # Check for validation
630  foreach ( $this->mFlatFields as $fieldname => $field ) {
631  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
632  continue;
633  }
634  if ( $field->isHidden( $this->mFieldData ) ) {
635  continue;
636  }
637  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
638  if ( $res !== true ) {
639  $valid = false;
640  if ( $res !== false && !$field->canDisplayErrors() ) {
641  if ( is_string( $res ) ) {
642  $hoistedErrors->fatal( 'rawmessage', $res );
643  } else {
644  $hoistedErrors->fatal( $res );
645  }
646  }
647  }
648  }
649 
650  if ( !$valid ) {
651  return $hoistedErrors;
652  }
653 
654  $callback = $this->mSubmitCallback;
655  if ( !is_callable( $callback ) ) {
656  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
657  'setSubmitCallback() to set one.' );
658  }
659 
660  $data = $this->filterDataForSubmit( $this->mFieldData );
661 
662  $res = call_user_func( $callback, $data, $this );
663  if ( $res === false ) {
664  $this->mWasSubmitted = false;
665  }
666 
667  return $res;
668  }
669 
681  public function wasSubmitted() {
682  return $this->mWasSubmitted;
683  }
684 
695  public function setSubmitCallback( $cb ) {
696  $this->mSubmitCallback = $cb;
697 
698  return $this;
699  }
700 
709  public function setValidationErrorMessage( $msg ) {
710  $this->mValidationErrorMessage = $msg;
711 
712  return $this;
713  }
714 
722  public function setIntro( $msg ) {
723  $this->setPreText( $msg );
724 
725  return $this;
726  }
727 
736  public function setPreText( $msg ) {
737  $this->mPre = $msg;
738 
739  return $this;
740  }
741 
749  public function addPreText( $msg ) {
750  $this->mPre .= $msg;
751 
752  return $this;
753  }
754 
762  public function getPreText() {
763  return $this->mPre;
764  }
765 
774  public function addHeaderText( $msg, $section = null ) {
775  if ( $section === null ) {
776  $this->mHeader .= $msg;
777  } else {
778  if ( !isset( $this->mSectionHeaders[$section] ) ) {
779  $this->mSectionHeaders[$section] = '';
780  }
781  $this->mSectionHeaders[$section] .= $msg;
782  }
783 
784  return $this;
785  }
786 
796  public function setHeaderText( $msg, $section = null ) {
797  if ( $section === null ) {
798  $this->mHeader = $msg;
799  } else {
800  $this->mSectionHeaders[$section] = $msg;
801  }
802 
803  return $this;
804  }
805 
813  public function getHeaderText( $section = null ) {
814  if ( $section === null ) {
815  return $this->mHeader;
816  } else {
817  return $this->mSectionHeaders[$section] ?? '';
818  }
819  }
820 
829  public function addFooterText( $msg, $section = null ) {
830  if ( $section === null ) {
831  $this->mFooter .= $msg;
832  } else {
833  if ( !isset( $this->mSectionFooters[$section] ) ) {
834  $this->mSectionFooters[$section] = '';
835  }
836  $this->mSectionFooters[$section] .= $msg;
837  }
838 
839  return $this;
840  }
841 
851  public function setFooterText( $msg, $section = null ) {
852  if ( $section === null ) {
853  $this->mFooter = $msg;
854  } else {
855  $this->mSectionFooters[$section] = $msg;
856  }
857 
858  return $this;
859  }
860 
868  public function getFooterText( $section = null ) {
869  if ( $section === null ) {
870  return $this->mFooter;
871  } else {
872  return $this->mSectionFooters[$section] ?? '';
873  }
874  }
875 
883  public function addPostText( $msg ) {
884  $this->mPost .= $msg;
885 
886  return $this;
887  }
888 
896  public function setPostText( $msg ) {
897  $this->mPost = $msg;
898 
899  return $this;
900  }
901 
911  public function addHiddenField( $name, $value, array $attribs = [] ) {
912  $attribs += [ 'name' => $name ];
913  $this->mHiddenFields[] = [ $value, $attribs ];
914 
915  return $this;
916  }
917 
928  public function addHiddenFields( array $fields ) {
929  foreach ( $fields as $name => $value ) {
930  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
931  }
932 
933  return $this;
934  }
935 
960  public function addButton( $data ) {
961  if ( !is_array( $data ) ) {
962  $args = func_get_args();
963  if ( count( $args ) < 2 || count( $args ) > 4 ) {
964  throw new InvalidArgumentException(
965  'Incorrect number of arguments for deprecated calling style'
966  );
967  }
968  $data = [
969  'name' => $args[0],
970  'value' => $args[1],
971  'id' => $args[2] ?? null,
972  'attribs' => $args[3] ?? null,
973  ];
974  } else {
975  if ( !isset( $data['name'] ) ) {
976  throw new InvalidArgumentException( 'A name is required' );
977  }
978  if ( !isset( $data['value'] ) ) {
979  throw new InvalidArgumentException( 'A value is required' );
980  }
981  }
982  $this->mButtons[] = $data + [
983  'id' => null,
984  'attribs' => null,
985  'flags' => null,
986  'framed' => true,
987  ];
988 
989  return $this;
990  }
991 
1001  public function setTokenSalt( $salt ) {
1002  $this->mTokenSalt = $salt;
1003 
1004  return $this;
1005  }
1006 
1019  public function displayForm( $submitResult ) {
1020  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1021  }
1022 
1030  public function getHTML( $submitResult ) {
1031  # For good measure (it is the default)
1032  $this->getOutput()->preventClickjacking();
1033  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1034  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1035 
1036  $html = ''
1037  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1038  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1039  . $this->getHeaderText()
1040  . $this->getBody()
1041  . $this->getHiddenFields()
1042  . $this->getButtons()
1043  . $this->getFooterText();
1044 
1045  $html = $this->wrapForm( $html );
1046 
1047  return '' . $this->mPre . $html . $this->mPost;
1048  }
1049 
1054  protected function getFormAttributes() {
1055  # Use multipart/form-data
1056  $encType = $this->mUseMultipart
1057  ? 'multipart/form-data'
1058  : 'application/x-www-form-urlencoded';
1059  # Attributes
1060  $attribs = [
1061  'class' => 'mw-htmlform',
1062  'action' => $this->getAction(),
1063  'method' => $this->getMethod(),
1064  'enctype' => $encType,
1065  ];
1066  if ( $this->mId ) {
1067  $attribs['id'] = $this->mId;
1068  }
1069  if ( is_string( $this->mAutocomplete ) ) {
1070  $attribs['autocomplete'] = $this->mAutocomplete;
1071  }
1072  if ( $this->mName ) {
1073  $attribs['name'] = $this->mName;
1074  }
1075  if ( $this->needsJSForHtml5FormValidation() ) {
1076  $attribs['novalidate'] = true;
1077  }
1078  return $attribs;
1079  }
1080 
1088  public function wrapForm( $html ) {
1089  # Include a <fieldset> wrapper for style, if requested.
1090  if ( $this->mWrapperLegend !== false ) {
1091  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1092  $html = Xml::fieldset( $legend, $html );
1093  }
1094 
1095  return Html::rawElement(
1096  'form',
1097  $this->getFormAttributes(),
1098  $html
1099  );
1100  }
1101 
1106  public function getHiddenFields() {
1107  $html = '';
1108  if ( $this->mFormIdentifier !== null ) {
1109  $html .= Html::hidden(
1110  'wpFormIdentifier',
1111  $this->mFormIdentifier
1112  ) . "\n";
1113  }
1114  if ( $this->getMethod() === 'post' ) {
1115  $html .= Html::hidden(
1116  'wpEditToken',
1117  $this->getUser()->getEditToken( $this->mTokenSalt ),
1118  [ 'id' => 'wpEditToken' ]
1119  ) . "\n";
1120  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1121  }
1122 
1123  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1124  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1125  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1126  }
1127 
1128  foreach ( $this->mHiddenFields as $data ) {
1129  list( $value, $attribs ) = $data;
1130  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1131  }
1132 
1133  return $html;
1134  }
1135 
1140  public function getButtons() {
1141  $buttons = '';
1142  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1143 
1144  if ( $this->mShowSubmit ) {
1145  $attribs = [];
1146 
1147  if ( isset( $this->mSubmitID ) ) {
1148  $attribs['id'] = $this->mSubmitID;
1149  }
1150 
1151  if ( isset( $this->mSubmitName ) ) {
1152  $attribs['name'] = $this->mSubmitName;
1153  }
1154 
1155  if ( isset( $this->mSubmitTooltip ) ) {
1156  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1157  }
1158 
1159  $attribs['class'] = [ 'mw-htmlform-submit' ];
1160 
1161  if ( $useMediaWikiUIEverywhere ) {
1162  foreach ( $this->mSubmitFlags as $flag ) {
1163  $attribs['class'][] = 'mw-ui-' . $flag;
1164  }
1165  $attribs['class'][] = 'mw-ui-button';
1166  }
1167 
1168  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1169  }
1170 
1171  if ( $this->mShowReset ) {
1172  $buttons .= Html::element(
1173  'input',
1174  [
1175  'type' => 'reset',
1176  'value' => $this->msg( 'htmlform-reset' )->text(),
1177  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1178  ]
1179  ) . "\n";
1180  }
1181 
1182  if ( $this->mShowCancel ) {
1183  $target = $this->mCancelTarget ?: Title::newMainPage();
1184  if ( $target instanceof Title ) {
1185  $target = $target->getLocalURL();
1186  }
1187  $buttons .= Html::element(
1188  'a',
1189  [
1190  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1191  'href' => $target,
1192  ],
1193  $this->msg( 'cancel' )->text()
1194  ) . "\n";
1195  }
1196 
1197  // IE<8 has bugs with <button>, so we'll need to avoid them.
1198  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1199 
1200  foreach ( $this->mButtons as $button ) {
1201  $attrs = [
1202  'type' => 'submit',
1203  'name' => $button['name'],
1204  'value' => $button['value']
1205  ];
1206 
1207  if ( isset( $button['label-message'] ) ) {
1208  $label = $this->getMessage( $button['label-message'] )->parse();
1209  } elseif ( isset( $button['label'] ) ) {
1210  $label = htmlspecialchars( $button['label'] );
1211  } elseif ( isset( $button['label-raw'] ) ) {
1212  $label = $button['label-raw'];
1213  } else {
1214  $label = htmlspecialchars( $button['value'] );
1215  }
1216 
1217  if ( $button['attribs'] ) {
1218  $attrs += $button['attribs'];
1219  }
1220 
1221  if ( isset( $button['id'] ) ) {
1222  $attrs['id'] = $button['id'];
1223  }
1224 
1225  if ( $useMediaWikiUIEverywhere ) {
1226  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1227  $attrs['class'][] = 'mw-ui-button';
1228  }
1229 
1230  if ( $isBadIE ) {
1231  $buttons .= Html::element( 'input', $attrs ) . "\n";
1232  } else {
1233  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1234  }
1235  }
1236 
1237  if ( !$buttons ) {
1238  return '';
1239  }
1240 
1241  return Html::rawElement( 'span',
1242  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1243  }
1244 
1249  public function getBody() {
1250  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1251  }
1252 
1262  public function getErrors( $errors ) {
1263  wfDeprecated( __METHOD__ );
1264  return $this->getErrorsOrWarnings( $errors, 'error' );
1265  }
1266 
1275  public function getErrorsOrWarnings( $elements, $elementsType ) {
1276  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1277  throw new DomainException( $elementsType . ' is not a valid type.' );
1278  }
1279  $elementstr = false;
1280  if ( $elements instanceof Status ) {
1281  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1282  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1283  if ( $status->isGood() ) {
1284  $elementstr = '';
1285  } else {
1286  $elementstr = $this->getOutput()->parse(
1287  $status->getWikiText()
1288  );
1289  }
1290  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1291  $elementstr = $this->formatErrors( $elements );
1292  } elseif ( $elementsType === 'error' ) {
1293  $elementstr = $elements;
1294  }
1295 
1296  return $elementstr
1297  ? Html::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1298  : '';
1299  }
1300 
1308  public function formatErrors( $errors ) {
1309  $errorstr = '';
1310 
1311  foreach ( $errors as $error ) {
1312  $errorstr .= Html::rawElement(
1313  'li',
1314  [],
1315  $this->getMessage( $error )->parse()
1316  );
1317  }
1318 
1319  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1320 
1321  return $errorstr;
1322  }
1323 
1331  public function setSubmitText( $t ) {
1332  $this->mSubmitText = $t;
1333 
1334  return $this;
1335  }
1336 
1343  public function setSubmitDestructive() {
1344  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1345 
1346  return $this;
1347  }
1348 
1357  public function setSubmitProgressive() {
1358  wfDeprecated( __METHOD__, '1.32' );
1359  $this->mSubmitFlags = [ 'progressive', 'primary' ];
1360 
1361  return $this;
1362  }
1363 
1372  public function setSubmitTextMsg( $msg ) {
1373  if ( !$msg instanceof Message ) {
1374  $msg = $this->msg( $msg );
1375  }
1376  $this->setSubmitText( $msg->text() );
1377 
1378  return $this;
1379  }
1380 
1385  public function getSubmitText() {
1386  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1387  }
1388 
1394  public function setSubmitName( $name ) {
1395  $this->mSubmitName = $name;
1396 
1397  return $this;
1398  }
1399 
1405  public function setSubmitTooltip( $name ) {
1406  $this->mSubmitTooltip = $name;
1407 
1408  return $this;
1409  }
1410 
1419  public function setSubmitID( $t ) {
1420  $this->mSubmitID = $t;
1421 
1422  return $this;
1423  }
1424 
1440  public function setFormIdentifier( $ident ) {
1441  $this->mFormIdentifier = $ident;
1442 
1443  return $this;
1444  }
1445 
1456  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1457  $this->mShowSubmit = !$suppressSubmit;
1458 
1459  return $this;
1460  }
1461 
1468  public function showCancel( $show = true ) {
1469  $this->mShowCancel = $show;
1470  return $this;
1471  }
1472 
1479  public function setCancelTarget( $target ) {
1480  $this->mCancelTarget = $target;
1481  return $this;
1482  }
1483 
1493  public function setTableId( $id ) {
1494  $this->mTableId = $id;
1495 
1496  return $this;
1497  }
1498 
1504  public function setId( $id ) {
1505  $this->mId = $id;
1506 
1507  return $this;
1508  }
1509 
1514  public function setName( $name ) {
1515  $this->mName = $name;
1516 
1517  return $this;
1518  }
1519 
1531  public function setWrapperLegend( $legend ) {
1532  $this->mWrapperLegend = $legend;
1533 
1534  return $this;
1535  }
1536 
1546  public function setWrapperLegendMsg( $msg ) {
1547  if ( !$msg instanceof Message ) {
1548  $msg = $this->msg( $msg );
1549  }
1550  $this->setWrapperLegend( $msg->text() );
1551 
1552  return $this;
1553  }
1554 
1564  public function setMessagePrefix( $p ) {
1565  $this->mMessagePrefix = $p;
1566 
1567  return $this;
1568  }
1569 
1577  public function setTitle( $t ) {
1578  $this->mTitle = $t;
1579 
1580  return $this;
1581  }
1582 
1587  public function getTitle() {
1588  return $this->mTitle === false
1589  ? $this->getContext()->getTitle()
1590  : $this->mTitle;
1591  }
1592 
1600  public function setMethod( $method = 'post' ) {
1601  $this->mMethod = strtolower( $method );
1602 
1603  return $this;
1604  }
1605 
1609  public function getMethod() {
1610  return $this->mMethod;
1611  }
1612 
1622  protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
1623  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1624  }
1625 
1642  public function displaySection( $fields,
1643  $sectionName = '',
1644  $fieldsetIDPrefix = '',
1645  &$hasUserVisibleFields = false
1646  ) {
1647  if ( $this->mFieldData === null ) {
1648  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1649  . 'You probably called displayForm() without calling prepareForm() first.' );
1650  }
1651 
1652  $displayFormat = $this->getDisplayFormat();
1653 
1654  $html = [];
1655  $subsectionHtml = '';
1656  $hasLabel = false;
1657 
1658  // Conveniently, PHP method names are case-insensitive.
1659  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1660  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1661 
1662  foreach ( $fields as $key => $value ) {
1663  if ( $value instanceof HTMLFormField ) {
1664  $v = array_key_exists( $key, $this->mFieldData )
1665  ? $this->mFieldData[$key]
1666  : $value->getDefault();
1667 
1668  $retval = $value->$getFieldHtmlMethod( $v );
1669 
1670  // check, if the form field should be added to
1671  // the output.
1672  if ( $value->hasVisibleOutput() ) {
1673  $html[] = $retval;
1674 
1675  $labelValue = trim( $value->getLabel() );
1676  if ( $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' && $labelValue !== '' ) {
1677  $hasLabel = true;
1678  }
1679 
1680  $hasUserVisibleFields = true;
1681  }
1682  } elseif ( is_array( $value ) ) {
1683  $subsectionHasVisibleFields = false;
1684  $section =
1685  $this->displaySection( $value,
1686  "mw-htmlform-$key",
1687  "$fieldsetIDPrefix$key-",
1688  $subsectionHasVisibleFields );
1689  $legend = null;
1690 
1691  if ( $subsectionHasVisibleFields === true ) {
1692  // Display the section with various niceties.
1693  $hasUserVisibleFields = true;
1694 
1695  $legend = $this->getLegend( $key );
1696 
1697  $section = $this->getHeaderText( $key ) .
1698  $section .
1699  $this->getFooterText( $key );
1700 
1701  $attributes = [];
1702  if ( $fieldsetIDPrefix ) {
1703  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1704  }
1705  $subsectionHtml .= $this->wrapFieldSetSection(
1706  $legend, $section, $attributes, $fields === $this->mFieldTree
1707  );
1708  } else {
1709  // Just return the inputs, nothing fancy.
1710  $subsectionHtml .= $section;
1711  }
1712  }
1713  }
1714 
1715  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1716 
1717  if ( $subsectionHtml ) {
1718  if ( $this->mSubSectionBeforeFields ) {
1719  return $subsectionHtml . "\n" . $html;
1720  } else {
1721  return $html . "\n" . $subsectionHtml;
1722  }
1723  } else {
1724  return $html;
1725  }
1726  }
1727 
1735  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1736  if ( !$fieldsHtml ) {
1737  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1738  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1739  return '';
1740  }
1741 
1742  $displayFormat = $this->getDisplayFormat();
1743  $html = implode( '', $fieldsHtml );
1744 
1745  if ( $displayFormat === 'raw' ) {
1746  return $html;
1747  }
1748 
1749  $classes = [];
1750 
1751  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1752  $classes[] = 'mw-htmlform-nolabel';
1753  }
1754 
1755  $attribs = [
1756  'class' => implode( ' ', $classes ),
1757  ];
1758 
1759  if ( $sectionName ) {
1760  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1761  }
1762 
1763  if ( $displayFormat === 'table' ) {
1764  return Html::rawElement( 'table',
1765  $attribs,
1766  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1767  } elseif ( $displayFormat === 'inline' ) {
1768  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1769  } else {
1770  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1771  }
1772  }
1773 
1777  public function loadData() {
1778  $fieldData = [];
1779 
1780  foreach ( $this->mFlatFields as $fieldname => $field ) {
1781  $request = $this->getRequest();
1782  if ( $field->skipLoadData( $request ) ) {
1783  continue;
1784  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1785  $fieldData[$fieldname] = $field->getDefault();
1786  } else {
1787  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1788  }
1789  }
1790 
1791  # Filter data.
1792  foreach ( $fieldData as $name => &$value ) {
1793  $field = $this->mFlatFields[$name];
1794  $value = $field->filter( $value, $this->mFlatFields );
1795  }
1796 
1797  $this->mFieldData = $fieldData;
1798  }
1799 
1807  public function suppressReset( $suppressReset = true ) {
1808  $this->mShowReset = !$suppressReset;
1809 
1810  return $this;
1811  }
1812 
1822  public function filterDataForSubmit( $data ) {
1823  return $data;
1824  }
1825 
1834  public function getLegend( $key ) {
1835  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1836  }
1837 
1848  public function setAction( $action ) {
1849  $this->mAction = $action;
1850 
1851  return $this;
1852  }
1853 
1861  public function getAction() {
1862  // If an action is alredy provided, return it
1863  if ( $this->mAction !== false ) {
1864  return $this->mAction;
1865  }
1866 
1867  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1868  // Check whether we are in GET mode and the ArticlePath contains a "?"
1869  // meaning that getLocalURL() would return something like "index.php?title=...".
1870  // As browser remove the query string before submitting GET forms,
1871  // it means that the title would be lost. In such case use wfScript() instead
1872  // and put title in an hidden field (see getHiddenFields()).
1873  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1874  return wfScript();
1875  }
1876 
1877  return $this->getTitle()->getLocalURL();
1878  }
1879 
1890  public function setAutocomplete( $autocomplete ) {
1891  $this->mAutocomplete = $autocomplete;
1892 
1893  return $this;
1894  }
1895 
1902  protected function getMessage( $value ) {
1903  return Message::newFromSpecifier( $value )->setContext( $this );
1904  }
1905 
1915  public function needsJSForHtml5FormValidation() {
1916  foreach ( $this->mFlatFields as $fieldname => $field ) {
1917  if ( $field->needsJSForHtml5FormValidation() ) {
1918  return true;
1919  }
1920  }
1921  return false;
1922  }
1923 }
HTMLFormField [] $mFlatFields
Definition: HTMLForm.php:182
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:584
string null $mAutocomplete
Form attribute autocomplete.
Definition: HTMLForm.php:226
needsJSForHtml5FormValidation()
Whether this form, with its current fields, requires the user agent to have JavaScript enabled for th...
Definition: HTMLForm.php:1915
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:2041
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:504
setSubmitID( $t)
Set the id for the submit button.
Definition: HTMLForm.php:1419
$mWasSubmitted
Definition: HTMLForm.php:212
static getClassFromDescriptor( $fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:451
setPostText( $msg)
Set text at the end of the display.
Definition: HTMLForm.php:896
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:590
$mWrapperLegend
Definition: HTMLForm.php:232
wrapFieldSetSection( $legend, $section, $attributes, $isRoot)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1622
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:1861
setSubmitName( $name)
Definition: HTMLForm.php:1394
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1468
setFooterText( $msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:851
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:431
$mUseMultipart
Definition: HTMLForm.php:228
setTokenSalt( $salt)
Set the salt for the edit token.
Definition: HTMLForm.php:1001
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:829
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher...
Definition: HTMLForm.php:605
setSubmitTooltip( $name)
Definition: HTMLForm.php:1405
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:1300
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
$mHiddenFields
Definition: HTMLForm.php:229
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:960
$value
getLegend( $key)
Get a string to go in the "<legend>" of a section fieldset.
Definition: HTMLForm.php:1834
hasField( $fieldname)
Definition: HTMLForm.php:370
displaySection( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1642
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
$mSubmitCallback
Definition: HTMLForm.php:191
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:283
$mSubmitTooltip
Definition: HTMLForm.php:207
IContextSource $context
setId( $id)
Definition: HTMLForm.php:1504
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:260
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:2039
getHiddenFields()
Get the hidden fields that should go inside the form.
Definition: HTMLForm.php:1106
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:238
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:928
if( $line===false) $args
Definition: cdb.php:64
bool string $mAction
Form action URL.
Definition: HTMLForm.php:219
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1600
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
$mValidationErrorMessage
Definition: HTMLForm.php:192
setSubmitProgressive()
Identify that the submit button in the form has a progressive action.
Definition: HTMLForm.php:1357
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: HTMLForm.php:479
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:308
displayForm( $submitResult)
Display the form (sending to the context&#39;s OutputPage object), with an appropriate error message or s...
Definition: HTMLForm.php:1019
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:254
setSubmitText( $t)
Set the text for the submit button.
Definition: HTMLForm.php:1331
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:566
static $mFieldData
Definition: HTMLForm.php:137
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1479
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:911
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1343
getHTML( $submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1030
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:1902
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:1440
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:1493
$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:1587
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:796
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:1308
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: HTMLForm.php:1088
getContext()
Get the base IContextSource object.
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1054
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:2041
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:1822
setValidationErrorMessage( $msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:709
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields&#39; HTML, merging it and wrapping.
Definition: HTMLForm.php:1735
array $availableSubclassDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:271
addPreText( $msg)
Add HTML to introductory message.
Definition: HTMLForm.php:749
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
setMessagePrefix( $p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1564
setSubmitCallback( $cb)
Set a callback to a function to do something with the form once it&#39;s been successfully validated...
Definition: HTMLForm.php:695
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1385
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:3089
$mCancelTarget
Definition: HTMLForm.php:189
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:681
$mFormIdentifier
Definition: HTMLForm.php:209
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:379
$mSectionFooters
Definition: HTMLForm.php:198
getPreText()
Get the introductory message HTML.
Definition: HTMLForm.php:762
$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:1777
setAction( $action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1848
suppressReset( $suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1807
getFooterText( $section=null)
Get footer text.
Definition: HTMLForm.php:868
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:791
getErrorsOrWarnings( $elements, $elementsType)
Returns a formatted list of errors or warnings from the given elements.
Definition: HTMLForm.php:1275
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getHeaderText( $section=null)
Get header text.
Definition: HTMLForm.php:813
getErrors( $errors)
Format and display an error message stack.
Definition: HTMLForm.php:1262
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:527
setIntro( $msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:722
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1372
$mSectionHeaders
Definition: HTMLForm.php:197
setAutocomplete( $autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1890
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element...
Definition: HTMLForm.php:1546
$mMessagePrefix
Definition: HTMLForm.php:179
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1249
setPreText( $msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:736
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1456
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2130
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:774
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1140
setDisplayFormat( $format)
Set format in which to display the form.
Definition: HTMLForm.php:396
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:2681
$mSubSectionBeforeFields
If true, sections that contain both fields and subsections will render their subsections before their...
Definition: HTMLForm.php:247
addPostText( $msg)
Add text to the end of the display.
Definition: HTMLForm.php:883
setName( $name)
Definition: HTMLForm.php:1514
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element...
Definition: HTMLForm.php:1531
setTitle( $t)
Set the title for form submission.
Definition: HTMLForm.php:1577