MediaWiki  REL1_31
HTMLForm.php
Go to the documentation of this file.
1 <?php
2 
24 use Wikimedia\ObjectFactory;
25 
130 class HTMLForm extends ContextSource {
131  // A mapping of 'type' inputs onto standard HTMLFormField subclasses
132  public static $typeMappings = [
133  'api' => HTMLApiField::class,
134  'text' => HTMLTextField::class,
135  'textwithbutton' => HTMLTextFieldWithButton::class,
136  'textarea' => HTMLTextAreaField::class,
137  'select' => HTMLSelectField::class,
138  'combobox' => HTMLComboboxField::class,
139  'radio' => HTMLRadioField::class,
140  'multiselect' => HTMLMultiSelectField::class,
141  'limitselect' => HTMLSelectLimitField::class,
142  'check' => HTMLCheckField::class,
143  'toggle' => HTMLCheckField::class,
144  'int' => HTMLIntField::class,
145  'float' => HTMLFloatField::class,
146  'info' => HTMLInfoField::class,
147  'selectorother' => HTMLSelectOrOtherField::class,
148  'selectandother' => HTMLSelectAndOtherField::class,
149  'namespaceselect' => HTMLSelectNamespace::class,
150  'namespaceselectwithbutton' => HTMLSelectNamespaceWithButton::class,
151  'tagfilter' => HTMLTagFilter::class,
152  'sizefilter' => HTMLSizeFilterField::class,
153  'submit' => HTMLSubmitField::class,
154  'hidden' => HTMLHiddenField::class,
155  'edittools' => HTMLEditTools::class,
156  'checkmatrix' => HTMLCheckMatrix::class,
157  'cloner' => HTMLFormFieldCloner::class,
158  'autocompleteselect' => HTMLAutoCompleteSelectField::class,
159  'date' => HTMLDateTimeField::class,
160  'time' => HTMLDateTimeField::class,
161  'datetime' => HTMLDateTimeField::class,
162  // HTMLTextField will output the correct type="" attribute automagically.
163  // There are about four zillion other HTML5 input types, like range, but
164  // we don't use those at the moment, so no point in adding all of them.
165  'email' => HTMLTextField::class,
166  'password' => HTMLTextField::class,
167  'url' => HTMLTextField::class,
168  'title' => HTMLTitleTextField::class,
169  'user' => HTMLUserTextField::class,
170  'usersmultiselect' => HTMLUsersMultiselectField::class,
171  ];
172 
173  public $mFieldData;
174 
175  protected $mMessagePrefix;
176 
178  protected $mFlatFields;
179 
180  protected $mFieldTree;
181  protected $mShowReset = false;
182  protected $mShowSubmit = true;
183  protected $mSubmitFlags = [ 'primary', 'progressive' ];
184  protected $mShowCancel = false;
185  protected $mCancelTarget;
186 
187  protected $mSubmitCallback;
189 
190  protected $mPre = '';
191  protected $mHeader = '';
192  protected $mFooter = '';
193  protected $mSectionHeaders = [];
194  protected $mSectionFooters = [];
195  protected $mPost = '';
196  protected $mId;
197  protected $mName;
198  protected $mTableId = '';
199 
200  protected $mSubmitID;
201  protected $mSubmitName;
202  protected $mSubmitText;
203  protected $mSubmitTooltip;
204 
205  protected $mFormIdentifier;
206  protected $mTitle;
207  protected $mMethod = 'post';
208  protected $mWasSubmitted = false;
209 
215  protected $mAction = false;
216 
222  protected $mAutocomplete = null;
223 
224  protected $mUseMultipart = false;
225  protected $mHiddenFields = [];
226  protected $mButtons = [];
227 
228  protected $mWrapperLegend = false;
229 
234  protected $mTokenSalt = '';
235 
243  protected $mSubSectionBeforeFields = true;
244 
250  protected $displayFormat = 'table';
251 
257  'table',
258  'div',
259  'raw',
260  'inline',
261  ];
262 
268  'vform',
269  'ooui',
270  ];
271 
279  public static function factory( $displayFormat/*, $arguments...*/ ) {
280  $arguments = func_get_args();
281  array_shift( $arguments );
282 
283  switch ( $displayFormat ) {
284  case 'vform':
285  return ObjectFactory::constructClassInstance( VFormHTMLForm::class, $arguments );
286  case 'ooui':
287  return ObjectFactory::constructClassInstance( OOUIHTMLForm::class, $arguments );
288  default:
290  $form = ObjectFactory::constructClassInstance( self::class, $arguments );
291  $form->setDisplayFormat( $displayFormat );
292  return $form;
293  }
294  }
295 
304  public function __construct( $descriptor, /*IContextSource*/ $context = null,
305  $messagePrefix = ''
306  ) {
307  if ( $context instanceof IContextSource ) {
308  $this->setContext( $context );
309  $this->mTitle = false; // We don't need them to set a title
310  $this->mMessagePrefix = $messagePrefix;
311  } elseif ( $context === null && $messagePrefix !== '' ) {
312  $this->mMessagePrefix = $messagePrefix;
313  } elseif ( is_string( $context ) && $messagePrefix === '' ) {
314  // B/C since 1.18
315  // it's actually $messagePrefix
316  $this->mMessagePrefix = $context;
317  }
318 
319  // Evil hack for mobile :(
320  if (
321  !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
322  && $this->displayFormat === 'table'
323  ) {
324  $this->displayFormat = 'div';
325  }
326 
327  // Expand out into a tree.
328  $loadedDescriptor = [];
329  $this->mFlatFields = [];
330 
331  foreach ( $descriptor as $fieldname => $info ) {
332  $section = isset( $info['section'] )
333  ? $info['section']
334  : '';
335 
336  if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
337  $this->mUseMultipart = true;
338  }
339 
340  $field = static::loadInputFromParameters( $fieldname, $info, $this );
341 
342  $setSection =& $loadedDescriptor;
343  if ( $section ) {
344  $sectionParts = explode( '/', $section );
345 
346  while ( count( $sectionParts ) ) {
347  $newName = array_shift( $sectionParts );
348 
349  if ( !isset( $setSection[$newName] ) ) {
350  $setSection[$newName] = [];
351  }
352 
353  $setSection =& $setSection[$newName];
354  }
355  }
356 
357  $setSection[$fieldname] = $field;
358  $this->mFlatFields[$fieldname] = $field;
359  }
360 
361  $this->mFieldTree = $loadedDescriptor;
362  }
363 
368  public function hasField( $fieldname ) {
369  return isset( $this->mFlatFields[$fieldname] );
370  }
371 
377  public function getField( $fieldname ) {
378  if ( !$this->hasField( $fieldname ) ) {
379  throw new DomainException( __METHOD__ . ': no field named ' . $fieldname );
380  }
381  return $this->mFlatFields[$fieldname];
382  }
383 
394  public function setDisplayFormat( $format ) {
395  if (
396  in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
397  in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
398  ) {
399  throw new MWException( 'Cannot change display format after creation, ' .
400  'use HTMLForm::factory() instead' );
401  }
402 
403  if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
404  throw new MWException( 'Display format must be one of ' .
405  print_r(
406  array_merge(
407  $this->availableDisplayFormats,
408  $this->availableSubclassDisplayFormats
409  ),
410  true
411  ) );
412  }
413 
414  // Evil hack for mobile :(
415  if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
416  $format = 'div';
417  }
418 
419  $this->displayFormat = $format;
420 
421  return $this;
422  }
423 
429  public function getDisplayFormat() {
430  return $this->displayFormat;
431  }
432 
449  public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
450  if ( isset( $descriptor['class'] ) ) {
451  $class = $descriptor['class'];
452  } elseif ( isset( $descriptor['type'] ) ) {
453  $class = static::$typeMappings[$descriptor['type']];
454  $descriptor['class'] = $class;
455  } else {
456  $class = null;
457  }
458 
459  if ( !$class ) {
460  throw new MWException( "Descriptor with no class for $fieldname: "
461  . print_r( $descriptor, true ) );
462  }
463 
464  return $class;
465  }
466 
477  public static function loadInputFromParameters( $fieldname, $descriptor,
478  HTMLForm $parent = null
479  ) {
480  $class = static::getClassFromDescriptor( $fieldname, $descriptor );
481 
482  $descriptor['fieldname'] = $fieldname;
483  if ( $parent ) {
484  $descriptor['parent'] = $parent;
485  }
486 
487  # @todo This will throw a fatal error whenever someone try to use
488  # 'class' to feed a CSS class instead of 'cssclass'. Would be
489  # great to avoid the fatal error and show a nice error.
490  return new $class( $descriptor );
491  }
492 
502  public function prepareForm() {
503  # Check if we have the info we need
504  if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
505  throw new MWException( 'You must call setTitle() on an HTMLForm' );
506  }
507 
508  # Load data from the request.
509  if (
510  $this->mFormIdentifier === null ||
511  $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier
512  ) {
513  $this->loadData();
514  } else {
515  $this->mFieldData = [];
516  }
517 
518  return $this;
519  }
520 
525  public function tryAuthorizedSubmit() {
526  $result = false;
527 
528  $identOkay = false;
529  if ( $this->mFormIdentifier === null ) {
530  $identOkay = true;
531  } else {
532  $identOkay = $this->getRequest()->getVal( 'wpFormIdentifier' ) === $this->mFormIdentifier;
533  }
534 
535  $tokenOkay = false;
536  if ( $this->getMethod() !== 'post' ) {
537  $tokenOkay = true; // no session check needed
538  } elseif ( $this->getRequest()->wasPosted() ) {
539  $editToken = $this->getRequest()->getVal( 'wpEditToken' );
540  if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
541  // Session tokens for logged-out users have no security value.
542  // However, if the user gave one, check it in order to give a nice
543  // "session expired" error instead of "permission denied" or such.
544  $tokenOkay = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
545  } else {
546  $tokenOkay = true;
547  }
548  }
549 
550  if ( $tokenOkay && $identOkay ) {
551  $this->mWasSubmitted = true;
552  $result = $this->trySubmit();
553  }
554 
555  return $result;
556  }
557 
564  public function show() {
565  $this->prepareForm();
566 
567  $result = $this->tryAuthorizedSubmit();
568  if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
569  return $result;
570  }
571 
572  $this->displayForm( $result );
573 
574  return false;
575  }
576 
582  public function showAlways() {
583  $this->prepareForm();
584 
585  $result = $this->tryAuthorizedSubmit();
586 
587  $this->displayForm( $result );
588 
589  return $result;
590  }
591 
603  public function trySubmit() {
604  $valid = true;
605  $hoistedErrors = Status::newGood();
606  if ( $this->mValidationErrorMessage ) {
607  foreach ( (array)$this->mValidationErrorMessage as $error ) {
608  call_user_func_array( [ $hoistedErrors, 'fatal' ], $error );
609  }
610  } else {
611  $hoistedErrors->fatal( 'htmlform-invalid-input' );
612  }
613 
614  $this->mWasSubmitted = true;
615 
616  # Check for cancelled submission
617  foreach ( $this->mFlatFields as $fieldname => $field ) {
618  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
619  continue;
620  }
621  if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
622  $this->mWasSubmitted = false;
623  return false;
624  }
625  }
626 
627  # Check for validation
628  foreach ( $this->mFlatFields as $fieldname => $field ) {
629  if ( !array_key_exists( $fieldname, $this->mFieldData ) ) {
630  continue;
631  }
632  if ( $field->isHidden( $this->mFieldData ) ) {
633  continue;
634  }
635  $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
636  if ( $res !== true ) {
637  $valid = false;
638  if ( $res !== false && !$field->canDisplayErrors() ) {
639  if ( is_string( $res ) ) {
640  $hoistedErrors->fatal( 'rawmessage', $res );
641  } else {
642  $hoistedErrors->fatal( $res );
643  }
644  }
645  }
646  }
647 
648  if ( !$valid ) {
649  return $hoistedErrors;
650  }
651 
652  $callback = $this->mSubmitCallback;
653  if ( !is_callable( $callback ) ) {
654  throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
655  'setSubmitCallback() to set one.' );
656  }
657 
658  $data = $this->filterDataForSubmit( $this->mFieldData );
659 
660  $res = call_user_func( $callback, $data, $this );
661  if ( $res === false ) {
662  $this->mWasSubmitted = false;
663  }
664 
665  return $res;
666  }
667 
679  public function wasSubmitted() {
680  return $this->mWasSubmitted;
681  }
682 
693  public function setSubmitCallback( $cb ) {
694  $this->mSubmitCallback = $cb;
695 
696  return $this;
697  }
698 
707  public function setValidationErrorMessage( $msg ) {
708  $this->mValidationErrorMessage = $msg;
709 
710  return $this;
711  }
712 
720  public function setIntro( $msg ) {
721  $this->setPreText( $msg );
722 
723  return $this;
724  }
725 
734  public function setPreText( $msg ) {
735  $this->mPre = $msg;
736 
737  return $this;
738  }
739 
747  public function addPreText( $msg ) {
748  $this->mPre .= $msg;
749 
750  return $this;
751  }
752 
761  public function addHeaderText( $msg, $section = null ) {
762  if ( $section === null ) {
763  $this->mHeader .= $msg;
764  } else {
765  if ( !isset( $this->mSectionHeaders[$section] ) ) {
766  $this->mSectionHeaders[$section] = '';
767  }
768  $this->mSectionHeaders[$section] .= $msg;
769  }
770 
771  return $this;
772  }
773 
783  public function setHeaderText( $msg, $section = null ) {
784  if ( $section === null ) {
785  $this->mHeader = $msg;
786  } else {
787  $this->mSectionHeaders[$section] = $msg;
788  }
789 
790  return $this;
791  }
792 
800  public function getHeaderText( $section = null ) {
801  if ( $section === null ) {
802  return $this->mHeader;
803  } else {
804  return isset( $this->mSectionHeaders[$section] ) ? $this->mSectionHeaders[$section] : '';
805  }
806  }
807 
816  public function addFooterText( $msg, $section = null ) {
817  if ( $section === null ) {
818  $this->mFooter .= $msg;
819  } else {
820  if ( !isset( $this->mSectionFooters[$section] ) ) {
821  $this->mSectionFooters[$section] = '';
822  }
823  $this->mSectionFooters[$section] .= $msg;
824  }
825 
826  return $this;
827  }
828 
838  public function setFooterText( $msg, $section = null ) {
839  if ( $section === null ) {
840  $this->mFooter = $msg;
841  } else {
842  $this->mSectionFooters[$section] = $msg;
843  }
844 
845  return $this;
846  }
847 
855  public function getFooterText( $section = null ) {
856  if ( $section === null ) {
857  return $this->mFooter;
858  } else {
859  return isset( $this->mSectionFooters[$section] ) ? $this->mSectionFooters[$section] : '';
860  }
861  }
862 
870  public function addPostText( $msg ) {
871  $this->mPost .= $msg;
872 
873  return $this;
874  }
875 
883  public function setPostText( $msg ) {
884  $this->mPost = $msg;
885 
886  return $this;
887  }
888 
898  public function addHiddenField( $name, $value, array $attribs = [] ) {
899  $attribs += [ 'name' => $name ];
900  $this->mHiddenFields[] = [ $value, $attribs ];
901 
902  return $this;
903  }
904 
915  public function addHiddenFields( array $fields ) {
916  foreach ( $fields as $name => $value ) {
917  $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
918  }
919 
920  return $this;
921  }
922 
947  public function addButton( $data ) {
948  if ( !is_array( $data ) ) {
949  $args = func_get_args();
950  if ( count( $args ) < 2 || count( $args ) > 4 ) {
951  throw new InvalidArgumentException(
952  'Incorrect number of arguments for deprecated calling style'
953  );
954  }
955  $data = [
956  'name' => $args[0],
957  'value' => $args[1],
958  'id' => isset( $args[2] ) ? $args[2] : null,
959  'attribs' => isset( $args[3] ) ? $args[3] : null,
960  ];
961  } else {
962  if ( !isset( $data['name'] ) ) {
963  throw new InvalidArgumentException( 'A name is required' );
964  }
965  if ( !isset( $data['value'] ) ) {
966  throw new InvalidArgumentException( 'A value is required' );
967  }
968  }
969  $this->mButtons[] = $data + [
970  'id' => null,
971  'attribs' => null,
972  'flags' => null,
973  'framed' => true,
974  ];
975 
976  return $this;
977  }
978 
988  public function setTokenSalt( $salt ) {
989  $this->mTokenSalt = $salt;
990 
991  return $this;
992  }
993 
1006  public function displayForm( $submitResult ) {
1007  $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
1008  }
1009 
1017  public function getHTML( $submitResult ) {
1018  # For good measure (it is the default)
1019  $this->getOutput()->preventClickjacking();
1020  $this->getOutput()->addModules( 'mediawiki.htmlform' );
1021  $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
1022 
1023  $html = ''
1024  . $this->getErrorsOrWarnings( $submitResult, 'error' )
1025  . $this->getErrorsOrWarnings( $submitResult, 'warning' )
1026  . $this->getHeaderText()
1027  . $this->getBody()
1028  . $this->getHiddenFields()
1029  . $this->getButtons()
1030  . $this->getFooterText();
1031 
1032  $html = $this->wrapForm( $html );
1033 
1034  return '' . $this->mPre . $html . $this->mPost;
1035  }
1036 
1041  protected function getFormAttributes() {
1042  # Use multipart/form-data
1043  $encType = $this->mUseMultipart
1044  ? 'multipart/form-data'
1045  : 'application/x-www-form-urlencoded';
1046  # Attributes
1047  $attribs = [
1048  'class' => 'mw-htmlform',
1049  'action' => $this->getAction(),
1050  'method' => $this->getMethod(),
1051  'enctype' => $encType,
1052  ];
1053  if ( $this->mId ) {
1054  $attribs['id'] = $this->mId;
1055  }
1056  if ( is_string( $this->mAutocomplete ) ) {
1057  $attribs['autocomplete'] = $this->mAutocomplete;
1058  }
1059  if ( $this->mName ) {
1060  $attribs['name'] = $this->mName;
1061  }
1062  if ( $this->needsJSForHtml5FormValidation() ) {
1063  $attribs['novalidate'] = true;
1064  }
1065  return $attribs;
1066  }
1067 
1075  public function wrapForm( $html ) {
1076  # Include a <fieldset> wrapper for style, if requested.
1077  if ( $this->mWrapperLegend !== false ) {
1078  $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1079  $html = Xml::fieldset( $legend, $html );
1080  }
1081 
1082  return Html::rawElement(
1083  'form',
1084  $this->getFormAttributes(),
1085  $html
1086  );
1087  }
1088 
1093  public function getHiddenFields() {
1094  $html = '';
1095  if ( $this->mFormIdentifier !== null ) {
1096  $html .= Html::hidden(
1097  'wpFormIdentifier',
1098  $this->mFormIdentifier
1099  ) . "\n";
1100  }
1101  if ( $this->getMethod() === 'post' ) {
1102  $html .= Html::hidden(
1103  'wpEditToken',
1104  $this->getUser()->getEditToken( $this->mTokenSalt ),
1105  [ 'id' => 'wpEditToken' ]
1106  ) . "\n";
1107  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1108  }
1109 
1110  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1111  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1112  $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1113  }
1114 
1115  foreach ( $this->mHiddenFields as $data ) {
1116  list( $value, $attribs ) = $data;
1117  $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1118  }
1119 
1120  return $html;
1121  }
1122 
1127  public function getButtons() {
1128  $buttons = '';
1129  $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1130 
1131  if ( $this->mShowSubmit ) {
1132  $attribs = [];
1133 
1134  if ( isset( $this->mSubmitID ) ) {
1135  $attribs['id'] = $this->mSubmitID;
1136  }
1137 
1138  if ( isset( $this->mSubmitName ) ) {
1139  $attribs['name'] = $this->mSubmitName;
1140  }
1141 
1142  if ( isset( $this->mSubmitTooltip ) ) {
1143  $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1144  }
1145 
1146  $attribs['class'] = [ 'mw-htmlform-submit' ];
1147 
1148  if ( $useMediaWikiUIEverywhere ) {
1149  foreach ( $this->mSubmitFlags as $flag ) {
1150  $attribs['class'][] = 'mw-ui-' . $flag;
1151  }
1152  $attribs['class'][] = 'mw-ui-button';
1153  }
1154 
1155  $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1156  }
1157 
1158  if ( $this->mShowReset ) {
1159  $buttons .= Html::element(
1160  'input',
1161  [
1162  'type' => 'reset',
1163  'value' => $this->msg( 'htmlform-reset' )->text(),
1164  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1165  ]
1166  ) . "\n";
1167  }
1168 
1169  if ( $this->mShowCancel ) {
1170  $target = $this->mCancelTarget ?: Title::newMainPage();
1171  if ( $target instanceof Title ) {
1172  $target = $target->getLocalURL();
1173  }
1174  $buttons .= Html::element(
1175  'a',
1176  [
1177  'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1178  'href' => $target,
1179  ],
1180  $this->msg( 'cancel' )->text()
1181  ) . "\n";
1182  }
1183 
1184  // IE<8 has bugs with <button>, so we'll need to avoid them.
1185  $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1186 
1187  foreach ( $this->mButtons as $button ) {
1188  $attrs = [
1189  'type' => 'submit',
1190  'name' => $button['name'],
1191  'value' => $button['value']
1192  ];
1193 
1194  if ( isset( $button['label-message'] ) ) {
1195  $label = $this->getMessage( $button['label-message'] )->parse();
1196  } elseif ( isset( $button['label'] ) ) {
1197  $label = htmlspecialchars( $button['label'] );
1198  } elseif ( isset( $button['label-raw'] ) ) {
1199  $label = $button['label-raw'];
1200  } else {
1201  $label = htmlspecialchars( $button['value'] );
1202  }
1203 
1204  if ( $button['attribs'] ) {
1205  $attrs += $button['attribs'];
1206  }
1207 
1208  if ( isset( $button['id'] ) ) {
1209  $attrs['id'] = $button['id'];
1210  }
1211 
1212  if ( $useMediaWikiUIEverywhere ) {
1213  $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1214  $attrs['class'][] = 'mw-ui-button';
1215  }
1216 
1217  if ( $isBadIE ) {
1218  $buttons .= Html::element( 'input', $attrs ) . "\n";
1219  } else {
1220  $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1221  }
1222  }
1223 
1224  if ( !$buttons ) {
1225  return '';
1226  }
1227 
1228  return Html::rawElement( 'span',
1229  [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1230  }
1231 
1236  public function getBody() {
1237  return $this->displaySection( $this->mFieldTree, $this->mTableId );
1238  }
1239 
1249  public function getErrors( $errors ) {
1250  wfDeprecated( __METHOD__ );
1251  return $this->getErrorsOrWarnings( $errors, 'error' );
1252  }
1253 
1262  public function getErrorsOrWarnings( $elements, $elementsType ) {
1263  if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
1264  throw new DomainException( $elementsType . ' is not a valid type.' );
1265  }
1266  $elementstr = false;
1267  if ( $elements instanceof Status ) {
1268  list( $errorStatus, $warningStatus ) = $elements->splitByErrorType();
1269  $status = $elementsType === 'error' ? $errorStatus : $warningStatus;
1270  if ( $status->isGood() ) {
1271  $elementstr = '';
1272  } else {
1273  $elementstr = $this->getOutput()->parse(
1274  $status->getWikiText()
1275  );
1276  }
1277  } elseif ( is_array( $elements ) && $elementsType === 'error' ) {
1278  $elementstr = $this->formatErrors( $elements );
1279  } elseif ( $elementsType === 'error' ) {
1280  $elementstr = $elements;
1281  }
1282 
1283  return $elementstr
1284  ? Html::rawElement( 'div', [ 'class' => $elementsType ], $elementstr )
1285  : '';
1286  }
1287 
1295  public function formatErrors( $errors ) {
1296  $errorstr = '';
1297 
1298  foreach ( $errors as $error ) {
1299  $errorstr .= Html::rawElement(
1300  'li',
1301  [],
1302  $this->getMessage( $error )->parse()
1303  );
1304  }
1305 
1306  $errorstr = Html::rawElement( 'ul', [], $errorstr );
1307 
1308  return $errorstr;
1309  }
1310 
1318  public function setSubmitText( $t ) {
1319  $this->mSubmitText = $t;
1320 
1321  return $this;
1322  }
1323 
1330  public function setSubmitDestructive() {
1331  $this->mSubmitFlags = [ 'destructive', 'primary' ];
1332 
1333  return $this;
1334  }
1335 
1342  public function setSubmitProgressive() {
1343  $this->mSubmitFlags = [ 'progressive', 'primary' ];
1344 
1345  return $this;
1346  }
1347 
1356  public function setSubmitTextMsg( $msg ) {
1357  if ( !$msg instanceof Message ) {
1358  $msg = $this->msg( $msg );
1359  }
1360  $this->setSubmitText( $msg->text() );
1361 
1362  return $this;
1363  }
1364 
1369  public function getSubmitText() {
1370  return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1371  }
1372 
1378  public function setSubmitName( $name ) {
1379  $this->mSubmitName = $name;
1380 
1381  return $this;
1382  }
1383 
1389  public function setSubmitTooltip( $name ) {
1390  $this->mSubmitTooltip = $name;
1391 
1392  return $this;
1393  }
1394 
1403  public function setSubmitID( $t ) {
1404  $this->mSubmitID = $t;
1405 
1406  return $this;
1407  }
1408 
1424  public function setFormIdentifier( $ident ) {
1425  $this->mFormIdentifier = $ident;
1426 
1427  return $this;
1428  }
1429 
1440  public function suppressDefaultSubmit( $suppressSubmit = true ) {
1441  $this->mShowSubmit = !$suppressSubmit;
1442 
1443  return $this;
1444  }
1445 
1452  public function showCancel( $show = true ) {
1453  $this->mShowCancel = $show;
1454  return $this;
1455  }
1456 
1463  public function setCancelTarget( $target ) {
1464  $this->mCancelTarget = $target;
1465  return $this;
1466  }
1467 
1477  public function setTableId( $id ) {
1478  $this->mTableId = $id;
1479 
1480  return $this;
1481  }
1482 
1488  public function setId( $id ) {
1489  $this->mId = $id;
1490 
1491  return $this;
1492  }
1493 
1498  public function setName( $name ) {
1499  $this->mName = $name;
1500 
1501  return $this;
1502  }
1503 
1515  public function setWrapperLegend( $legend ) {
1516  $this->mWrapperLegend = $legend;
1517 
1518  return $this;
1519  }
1520 
1530  public function setWrapperLegendMsg( $msg ) {
1531  if ( !$msg instanceof Message ) {
1532  $msg = $this->msg( $msg );
1533  }
1534  $this->setWrapperLegend( $msg->text() );
1535 
1536  return $this;
1537  }
1538 
1548  public function setMessagePrefix( $p ) {
1549  $this->mMessagePrefix = $p;
1550 
1551  return $this;
1552  }
1553 
1561  public function setTitle( $t ) {
1562  $this->mTitle = $t;
1563 
1564  return $this;
1565  }
1566 
1571  public function getTitle() {
1572  return $this->mTitle === false
1573  ? $this->getContext()->getTitle()
1574  : $this->mTitle;
1575  }
1576 
1584  public function setMethod( $method = 'post' ) {
1585  $this->mMethod = strtolower( $method );
1586 
1587  return $this;
1588  }
1589 
1593  public function getMethod() {
1594  return $this->mMethod;
1595  }
1596 
1605  protected function wrapFieldSetSection( $legend, $section, $attributes ) {
1606  return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1607  }
1608 
1625  public function displaySection( $fields,
1626  $sectionName = '',
1627  $fieldsetIDPrefix = '',
1628  &$hasUserVisibleFields = false
1629  ) {
1630  if ( $this->mFieldData === null ) {
1631  throw new LogicException( 'HTMLForm::displaySection() called on uninitialized field data. '
1632  . 'You probably called displayForm() without calling prepareForm() first.' );
1633  }
1634 
1635  $displayFormat = $this->getDisplayFormat();
1636 
1637  $html = [];
1638  $subsectionHtml = '';
1639  $hasLabel = false;
1640 
1641  // Conveniently, PHP method names are case-insensitive.
1642  // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1643  $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1644 
1645  foreach ( $fields as $key => $value ) {
1646  if ( $value instanceof HTMLFormField ) {
1647  $v = array_key_exists( $key, $this->mFieldData )
1648  ? $this->mFieldData[$key]
1649  : $value->getDefault();
1650 
1651  $retval = $value->$getFieldHtmlMethod( $v );
1652 
1653  // check, if the form field should be added to
1654  // the output.
1655  if ( $value->hasVisibleOutput() ) {
1656  $html[] = $retval;
1657 
1658  $labelValue = trim( $value->getLabel() );
1659  if ( $labelValue !== '&#160;' && $labelValue !== '' ) {
1660  $hasLabel = true;
1661  }
1662 
1663  $hasUserVisibleFields = true;
1664  }
1665  } elseif ( is_array( $value ) ) {
1666  $subsectionHasVisibleFields = false;
1667  $section =
1668  $this->displaySection( $value,
1669  "mw-htmlform-$key",
1670  "$fieldsetIDPrefix$key-",
1671  $subsectionHasVisibleFields );
1672  $legend = null;
1673 
1674  if ( $subsectionHasVisibleFields === true ) {
1675  // Display the section with various niceties.
1676  $hasUserVisibleFields = true;
1677 
1678  $legend = $this->getLegend( $key );
1679 
1680  $section = $this->getHeaderText( $key ) .
1681  $section .
1682  $this->getFooterText( $key );
1683 
1684  $attributes = [];
1685  if ( $fieldsetIDPrefix ) {
1686  $attributes['id'] = Sanitizer::escapeIdForAttribute( "$fieldsetIDPrefix$key" );
1687  }
1688  $subsectionHtml .= $this->wrapFieldSetSection( $legend, $section, $attributes );
1689  } else {
1690  // Just return the inputs, nothing fancy.
1691  $subsectionHtml .= $section;
1692  }
1693  }
1694  }
1695 
1696  $html = $this->formatSection( $html, $sectionName, $hasLabel );
1697 
1698  if ( $subsectionHtml ) {
1699  if ( $this->mSubSectionBeforeFields ) {
1700  return $subsectionHtml . "\n" . $html;
1701  } else {
1702  return $html . "\n" . $subsectionHtml;
1703  }
1704  } else {
1705  return $html;
1706  }
1707  }
1708 
1716  protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1717  if ( !$fieldsHtml ) {
1718  // Do not generate any wrappers for empty sections. Sections may be empty if they only have
1719  // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
1720  return '';
1721  }
1722 
1723  $displayFormat = $this->getDisplayFormat();
1724  $html = implode( '', $fieldsHtml );
1725 
1726  if ( $displayFormat === 'raw' ) {
1727  return $html;
1728  }
1729 
1730  $classes = [];
1731 
1732  if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1733  $classes[] = 'mw-htmlform-nolabel';
1734  }
1735 
1736  $attribs = [
1737  'class' => implode( ' ', $classes ),
1738  ];
1739 
1740  if ( $sectionName ) {
1741  $attribs['id'] = Sanitizer::escapeIdForAttribute( $sectionName );
1742  }
1743 
1744  if ( $displayFormat === 'table' ) {
1745  return Html::rawElement( 'table',
1746  $attribs,
1747  Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1748  } elseif ( $displayFormat === 'inline' ) {
1749  return Html::rawElement( 'span', $attribs, "\n$html\n" );
1750  } else {
1751  return Html::rawElement( 'div', $attribs, "\n$html\n" );
1752  }
1753  }
1754 
1758  public function loadData() {
1759  $fieldData = [];
1760 
1761  foreach ( $this->mFlatFields as $fieldname => $field ) {
1762  $request = $this->getRequest();
1763  if ( $field->skipLoadData( $request ) ) {
1764  continue;
1765  } elseif ( !empty( $field->mParams['disabled'] ) ) {
1766  $fieldData[$fieldname] = $field->getDefault();
1767  } else {
1768  $fieldData[$fieldname] = $field->loadDataFromRequest( $request );
1769  }
1770  }
1771 
1772  # Filter data.
1773  foreach ( $fieldData as $name => &$value ) {
1774  $field = $this->mFlatFields[$name];
1775  $value = $field->filter( $value, $this->mFlatFields );
1776  }
1777 
1778  $this->mFieldData = $fieldData;
1779  }
1780 
1788  public function suppressReset( $suppressReset = true ) {
1789  $this->mShowReset = !$suppressReset;
1790 
1791  return $this;
1792  }
1793 
1803  public function filterDataForSubmit( $data ) {
1804  return $data;
1805  }
1806 
1815  public function getLegend( $key ) {
1816  return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1817  }
1818 
1829  public function setAction( $action ) {
1830  $this->mAction = $action;
1831 
1832  return $this;
1833  }
1834 
1842  public function getAction() {
1843  // If an action is alredy provided, return it
1844  if ( $this->mAction !== false ) {
1845  return $this->mAction;
1846  }
1847 
1848  $articlePath = $this->getConfig()->get( 'ArticlePath' );
1849  // Check whether we are in GET mode and the ArticlePath contains a "?"
1850  // meaning that getLocalURL() would return something like "index.php?title=...".
1851  // As browser remove the query string before submitting GET forms,
1852  // it means that the title would be lost. In such case use wfScript() instead
1853  // and put title in an hidden field (see getHiddenFields()).
1854  if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1855  return wfScript();
1856  }
1857 
1858  return $this->getTitle()->getLocalURL();
1859  }
1860 
1871  public function setAutocomplete( $autocomplete ) {
1872  $this->mAutocomplete = $autocomplete;
1873 
1874  return $this;
1875  }
1876 
1883  protected function getMessage( $value ) {
1884  return Message::newFromSpecifier( $value )->setContext( $this );
1885  }
1886 
1896  public function needsJSForHtml5FormValidation() {
1897  foreach ( $this->mFlatFields as $fieldname => $field ) {
1898  if ( $field->needsJSForHtml5FormValidation() ) {
1899  return true;
1900  }
1901  }
1902  return false;
1903  }
1904 }
HTMLForm\$mSubSectionBeforeFields
$mSubSectionBeforeFields
If true, sections that contain both fields and subsections will render their subsections before their...
Definition: HTMLForm.php:243
HTMLForm\getLegend
getLegend( $key)
Get a string to go in the "<legend>" of a section fieldset.
Definition: HTMLForm.php:1815
HTMLForm\$mTokenSalt
string array $mTokenSalt
Salt for the edit token.
Definition: HTMLForm.php:234
HTMLForm\$typeMappings
static $typeMappings
Definition: HTMLForm.php:132
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
HTMLForm\setPostText
setPostText( $msg)
Set text at the end of the display.
Definition: HTMLForm.php:883
HTMLForm\setAutocomplete
setAutocomplete( $autocomplete)
Set the value for the autocomplete attribute of the form.
Definition: HTMLForm.php:1871
Message\newFromSpecifier
static newFromSpecifier( $value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:414
HTMLForm\$mSubmitText
$mSubmitText
Definition: HTMLForm.php:202
HTMLForm\prepareForm
prepareForm()
Prepare form for submission.
Definition: HTMLForm.php:502
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:40
HTMLForm\hasField
hasField( $fieldname)
Definition: HTMLForm.php:368
HTMLForm\setPreText
setPreText( $msg)
Set the introductory message HTML, overwriting any existing message.
Definition: HTMLForm.php:734
HTMLForm\suppressDefaultSubmit
suppressDefaultSubmit( $suppressSubmit=true)
Stop a default submit button being shown for this form.
Definition: HTMLForm.php:1440
HTMLForm\$mSectionHeaders
$mSectionHeaders
Definition: HTMLForm.php:193
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
HTMLForm\setSubmitName
setSubmitName( $name)
Definition: HTMLForm.php:1378
HTMLForm\setFooterText
setFooterText( $msg, $section=null)
Set footer text, inside the form.
Definition: HTMLForm.php:838
HTMLForm\$mFieldTree
$mFieldTree
Definition: HTMLForm.php:180
HTMLForm\setIntro
setIntro( $msg)
Set the introductory message, overwriting any existing message.
Definition: HTMLForm.php:720
$html
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:2013
array
the array() calling protocol came about after MediaWiki 1.4rc1.
HTMLForm\getErrors
getErrors( $errors)
Format and display an error message stack.
Definition: HTMLForm.php:1249
HTMLForm\tryAuthorizedSubmit
tryAuthorizedSubmit()
Try submitting, with edit token check first.
Definition: HTMLForm.php:525
HTMLForm\setSubmitTooltip
setSubmitTooltip( $name)
Definition: HTMLForm.php:1389
HTMLForm\addHeaderText
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:761
HTMLForm\$mTitle
$mTitle
Definition: HTMLForm.php:206
HTMLForm\setDisplayFormat
setDisplayFormat( $format)
Set format in which to display the form.
Definition: HTMLForm.php:394
HTMLForm\wrapForm
wrapForm( $html)
Wrap the form innards in an actual "<form>" element.
Definition: HTMLForm.php:1075
text
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:18
Sanitizer\escapeIdForAttribute
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:1261
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
Title\newMainPage
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:586
HTMLForm\getHiddenFields
getHiddenFields()
Get the hidden fields that should go inside the form.
Definition: HTMLForm.php:1093
HTMLForm\getDisplayFormat
getDisplayFormat()
Getter for displayFormat.
Definition: HTMLForm.php:429
HTMLForm\$mWasSubmitted
$mWasSubmitted
Definition: HTMLForm.php:208
HTMLForm\$mFieldData
$mFieldData
Definition: HTMLForm.php:173
HTMLForm\setHeaderText
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:783
HTMLForm\formatErrors
formatErrors( $errors)
Format a stack of error messages into a single HTML string.
Definition: HTMLForm.php:1295
HTMLForm\getClassFromDescriptor
static getClassFromDescriptor( $fieldname, &$descriptor)
Get the HTMLFormField subclass for this descriptor.
Definition: HTMLForm.php:449
HTMLForm\showCancel
showCancel( $show=true)
Show a cancel button (or prevent it).
Definition: HTMLForm.php:1452
HTMLForm\$mWrapperLegend
$mWrapperLegend
Definition: HTMLForm.php:228
HTMLForm\$mUseMultipart
$mUseMultipart
Definition: HTMLForm.php:224
HTMLForm\$mShowSubmit
$mShowSubmit
Definition: HTMLForm.php:182
HTMLForm\$mAutocomplete
string null $mAutocomplete
Form attribute autocomplete.
Definition: HTMLForm.php:222
HTMLForm\$mCancelTarget
$mCancelTarget
Definition: HTMLForm.php:185
HTMLForm\setTokenSalt
setTokenSalt( $salt)
Set the salt for the edit token.
Definition: HTMLForm.php:988
HTMLForm\$mSubmitTooltip
$mSubmitTooltip
Definition: HTMLForm.php:203
HTMLForm\$displayFormat
string $displayFormat
Format in which to display form.
Definition: HTMLForm.php:250
HTMLForm\show
show()
The here's-one-I-made-earlier option: do the submission if posted, or display the form with or withou...
Definition: HTMLForm.php:564
HTMLForm\$mSubmitID
$mSubmitID
Definition: HTMLForm.php:200
HTMLForm\setCancelTarget
setCancelTarget( $target)
Sets the target where the user is redirected to after clicking cancel.
Definition: HTMLForm.php:1463
HTMLForm\getBody
getBody()
Get the whole body of the form.
Definition: HTMLForm.php:1236
$res
$res
Definition: database.txt:21
ContextSource\getRequest
getRequest()
Definition: ContextSource.php:71
HTMLForm\$mShowReset
$mShowReset
Definition: HTMLForm.php:181
HTMLForm\$mTableId
$mTableId
Definition: HTMLForm.php:198
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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! 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! 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:1993
HTMLForm\$mSubmitName
$mSubmitName
Definition: HTMLForm.php:201
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
HTMLForm\getAction
getAction()
Get the value for the action attribute of the form.
Definition: HTMLForm.php:1842
HTMLForm\setSubmitProgressive
setSubmitProgressive()
Identify that the submit button in the form has a progressive action.
Definition: HTMLForm.php:1342
HTMLForm\setMethod
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1584
HTMLForm\$mButtons
$mButtons
Definition: HTMLForm.php:226
php
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:37
Linker\tooltipAndAccesskeyAttribs
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2135
HTMLForm\__construct
__construct( $descriptor, $context=null, $messagePrefix='')
Build a new HTMLForm from an array of field attributes.
Definition: HTMLForm.php:304
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
Xml\fieldset
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:610
HTMLForm\setSubmitText
setSubmitText( $t)
Set the text for the submit button.
Definition: HTMLForm.php:1318
HTMLForm\trySubmit
trySubmit()
Validate all the fields, and call the submission callback function if everything is kosher.
Definition: HTMLForm.php:603
StatusValue\isGood
isGood()
Returns whether the operation completed and didn't have any error or warnings.
Definition: StatusValue.php:121
HTMLForm\$mSubmitFlags
$mSubmitFlags
Definition: HTMLForm.php:183
MWException
MediaWiki exception.
Definition: MWException.php:26
HTMLForm\$mAction
bool string $mAction
Form action URL.
Definition: HTMLForm.php:215
HTMLForm\setFormIdentifier
setFormIdentifier( $ident)
Set an internal identifier for this form.
Definition: HTMLForm.php:1424
HTMLForm\wrapFieldSetSection
wrapFieldSetSection( $legend, $section, $attributes)
Wraps the given $section into an user-visible fieldset.
Definition: HTMLForm.php:1605
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1123
HTMLForm\getHeaderText
getHeaderText( $section=null)
Get header text.
Definition: HTMLForm.php:800
HTMLForm\addButton
addButton( $data)
Add a button to the form.
Definition: HTMLForm.php:947
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
HTMLForm\addHiddenField
addHiddenField( $name, $value, array $attribs=[])
Add a hidden field to the output.
Definition: HTMLForm.php:898
ContextSource\getOutput
getOutput()
Definition: ContextSource.php:112
HTMLForm\setSubmitID
setSubmitID( $t)
Set the id for the submit button.
Definition: HTMLForm.php:1403
ContextSource
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
Definition: ContextSource.php:29
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:279
HTMLFormField
The parent class to generate form fields.
Definition: HTMLFormField.php:7
HTMLForm\wasSubmitted
wasSubmitted()
Test whether the form was considered to have been submitted or not, i.e.
Definition: HTMLForm.php:679
HTMLForm\$mFormIdentifier
$mFormIdentifier
Definition: HTMLForm.php:205
HTMLForm\formatSection
formatSection(array $fieldsHtml, $sectionName, $anyFieldHasLabel)
Put a form section together from the individual fields' HTML, merging it and wrapping.
Definition: HTMLForm.php:1716
HTMLForm\setMessagePrefix
setMessagePrefix( $p)
Set the prefix for various default messages.
Definition: HTMLForm.php:1548
HTMLForm\setSubmitCallback
setSubmitCallback( $cb)
Set a callback to a function to do something with the form once it's been successfully validated.
Definition: HTMLForm.php:693
HTMLForm\$mId
$mId
Definition: HTMLForm.php:196
HTMLForm\$mSectionFooters
$mSectionFooters
Definition: HTMLForm.php:194
HTMLForm\loadInputFromParameters
static loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent=null)
Initialise a new Object for the field.
Definition: HTMLForm.php:477
ContextSource\setContext
setContext(IContextSource $context)
Definition: ContextSource.php:55
list
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
HTMLForm\$mPost
$mPost
Definition: HTMLForm.php:195
HTMLForm\getErrorsOrWarnings
getErrorsOrWarnings( $elements, $elementsType)
Returns a formatted list of errors or warnings from the given elements.
Definition: HTMLForm.php:1262
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:774
$attribs
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:2014
HTMLForm\$mFooter
$mFooter
Definition: HTMLForm.php:192
HTMLForm\getFormAttributes
getFormAttributes()
Get HTML attributes for the <form> tag.
Definition: HTMLForm.php:1041
HTMLForm\$mMethod
$mMethod
Definition: HTMLForm.php:207
$value
$value
Definition: styleTest.css.php:45
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
HTMLForm\setId
setId( $id)
Definition: HTMLForm.php:1488
HTMLForm\$availableSubclassDisplayFormats
array $availableSubclassDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:267
HTMLForm\$availableDisplayFormats
array $availableDisplayFormats
Available formats in which to display the form.
Definition: HTMLForm.php:256
HTMLForm\setWrapperLegend
setWrapperLegend( $legend)
Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element.
Definition: HTMLForm.php:1515
HTMLForm\displaySection
displaySection( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)
Definition: HTMLForm.php:1625
$status
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. '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:1255
HTMLForm\$mSubmitCallback
$mSubmitCallback
Definition: HTMLForm.php:187
HTMLForm\loadData
loadData()
Construct the form fields from the Descriptor array.
Definition: HTMLForm.php:1758
HTMLForm\showAlways
showAlways()
Same as self::show with the difference, that the form will be added to the output,...
Definition: HTMLForm.php:582
HTMLForm\$mName
$mName
Definition: HTMLForm.php:197
HTMLForm\setSubmitDestructive
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1330
HTMLForm\setValidationErrorMessage
setValidationErrorMessage( $msg)
Set a message to display on a validation error.
Definition: HTMLForm.php:707
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
HTMLForm\setSubmitTextMsg
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1356
$args
if( $line===false) $args
Definition: cdb.php:64
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
HTMLForm\setName
setName( $name)
Definition: HTMLForm.php:1498
HTMLForm\$mPre
$mPre
Definition: HTMLForm.php:190
HTMLForm\getHTML
getHTML( $submitResult)
Returns the raw HTML generated by the form.
Definition: HTMLForm.php:1017
HTMLForm\getSubmitText
getSubmitText()
Get the text for the submit button, either customised or a default.
Definition: HTMLForm.php:1369
HTMLForm\getMessage
getMessage( $value)
Turns a *-message parameter (which could be a MessageSpecifier, or a message name,...
Definition: HTMLForm.php:1883
$section
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:3022
HTMLForm\addHiddenFields
addHiddenFields(array $fields)
Add an array of hidden fields to the output.
Definition: HTMLForm.php:915
HTMLForm\$mShowCancel
$mShowCancel
Definition: HTMLForm.php:184
HTMLForm\setWrapperLegendMsg
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
Definition: HTMLForm.php:1530
HTMLForm\$mValidationErrorMessage
$mValidationErrorMessage
Definition: HTMLForm.php:188
HTMLForm\setAction
setAction( $action)
Set the value for the action attribute of the form.
Definition: HTMLForm.php:1829
HTMLForm\$mHeader
$mHeader
Definition: HTMLForm.php:191
HTMLForm\setTitle
setTitle( $t)
Set the title for form submission.
Definition: HTMLForm.php:1561
as
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:22
HTMLForm\setTableId
setTableId( $id)
Set the id of the <table> or outermost <div> element.
Definition: HTMLForm.php:1477
HTMLForm\$mMessagePrefix
$mMessagePrefix
Definition: HTMLForm.php:175
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
HTMLForm\displayForm
displayForm( $submitResult)
Display the form (sending to the context's OutputPage object), with an appropriate error message or s...
Definition: HTMLForm.php:1006
HTMLForm\$mHiddenFields
$mHiddenFields
Definition: HTMLForm.php:225
Message
The Message class provides methods which fulfil two basic services:
Definition: Message.php:159
HTMLForm\getTitle
getTitle()
Get the title.
Definition: HTMLForm.php:1571
HTMLForm\filterDataForSubmit
filterDataForSubmit( $data)
Overload this if you want to apply special filtration routines to the form as a whole,...
Definition: HTMLForm.php:1803
HTMLForm\getMethod
getMethod()
Definition: HTMLForm.php:1593
HTMLForm\addPreText
addPreText( $msg)
Add HTML to introductory message.
Definition: HTMLForm.php:747
class
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:56
$t
$t
Definition: testCompression.php:69
HTMLForm\getField
getField( $fieldname)
Definition: HTMLForm.php:377
$request
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:2806
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
HTMLForm\addPostText
addPostText( $msg)
Add text to the end of the display.
Definition: HTMLForm.php:870
HTMLForm\suppressReset
suppressReset( $suppressReset=true)
Stop a reset button being shown for this form.
Definition: HTMLForm.php:1788
HTMLForm\getFooterText
getFooterText( $section=null)
Get footer text.
Definition: HTMLForm.php:855
$retval
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 account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
HTMLForm\$mFlatFields
HTMLFormField[] $mFlatFields
Definition: HTMLForm.php:178
HTMLForm\getButtons
getButtons()
Get the submit and (potentially) reset buttons.
Definition: HTMLForm.php:1127
HTMLForm\addFooterText
addFooterText( $msg, $section=null)
Add footer text, inside the form.
Definition: HTMLForm.php:816
Xml\submitButton
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:460
HTMLForm\needsJSForHtml5FormValidation
needsJSForHtml5FormValidation()
Whether this form, with its current fields, requires the user agent to have JavaScript enabled for th...
Definition: HTMLForm.php:1896
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130