MediaWiki  REL1_31
SpecialTags.php
Go to the documentation of this file.
1 <?php
29 class SpecialTags extends SpecialPage {
30 
35 
40 
45 
46  function __construct() {
47  parent::__construct( 'Tags' );
48  }
49 
50  function execute( $par ) {
51  $this->setHeaders();
52  $this->outputHeader();
53 
54  $request = $this->getRequest();
55  switch ( $par ) {
56  case 'delete':
57  $this->showDeleteTagForm( $request->getVal( 'tag' ) );
58  break;
59  case 'activate':
60  $this->showActivateDeactivateForm( $request->getVal( 'tag' ), true );
61  break;
62  case 'deactivate':
63  $this->showActivateDeactivateForm( $request->getVal( 'tag' ), false );
64  break;
65  case 'create':
66  // fall through, thanks to HTMLForm's logic
67  default:
68  $this->showTagList();
69  break;
70  }
71  }
72 
73  function showTagList() {
74  $out = $this->getOutput();
75  $out->setPageTitle( $this->msg( 'tags-title' ) );
76  $out->wrapWikiMsg( "<div class='mw-tags-intro'>\n$1\n</div>", 'tags-intro' );
77 
78  $user = $this->getUser();
79  $userCanManage = $user->isAllowed( 'managechangetags' );
80  $userCanDelete = $user->isAllowed( 'deletechangetags' );
81  $userCanEditInterface = $user->isAllowed( 'editinterface' );
82 
83  // Show form to create a tag
84  if ( $userCanManage ) {
85  $fields = [
86  'Tag' => [
87  'type' => 'text',
88  'label' => $this->msg( 'tags-create-tag-name' )->plain(),
89  'required' => true,
90  ],
91  'Reason' => [
92  'type' => 'text',
93  'label' => $this->msg( 'tags-create-reason' )->plain(),
94  'size' => 50,
95  ],
96  'IgnoreWarnings' => [
97  'type' => 'hidden',
98  ],
99  ];
100 
101  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
102  $form->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
103  $form->setWrapperLegendMsg( 'tags-create-heading' );
104  $form->setHeaderText( $this->msg( 'tags-create-explanation' )->parseAsBlock() );
105  $form->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
106  $form->setSubmitTextMsg( 'tags-create-submit' );
107  $form->show();
108 
109  // If processCreateTagForm generated a redirect, there's no point
110  // continuing with this, as the user is just going to end up getting sent
111  // somewhere else. Additionally, if we keep going here, we end up
112  // populating the memcache of tag data (see ChangeTags::listDefinedTags)
113  // with out-of-date data from the replica DB, because the replica DB hasn't caught
114  // up to the fact that a new tag has been created as part of an implicit,
115  // as yet uncommitted transaction on master.
116  if ( $out->getRedirect() !== '' ) {
117  return;
118  }
119  }
120 
121  // Used to get hitcounts for #doTagRow()
122  $tagStats = ChangeTags::tagUsageStatistics();
123 
124  // Used in #doTagRow()
125  $this->explicitlyDefinedTags = array_fill_keys(
127  $this->softwareDefinedTags = array_fill_keys(
129 
130  // List all defined tags, even if they were never applied
131  $definedTags = array_keys( $this->explicitlyDefinedTags + $this->softwareDefinedTags );
132 
133  // Show header only if there exists atleast one tag
134  if ( !$tagStats && !$definedTags ) {
135  return;
136  }
137 
138  // Write the headers
139  $html = Xml::tags( 'tr', null, Xml::tags( 'th', null, $this->msg( 'tags-tag' )->parse() ) .
140  Xml::tags( 'th', null, $this->msg( 'tags-display-header' )->parse() ) .
141  Xml::tags( 'th', null, $this->msg( 'tags-description-header' )->parse() ) .
142  Xml::tags( 'th', null, $this->msg( 'tags-source-header' )->parse() ) .
143  Xml::tags( 'th', null, $this->msg( 'tags-active-header' )->parse() ) .
144  Xml::tags( 'th', null, $this->msg( 'tags-hitcount-header' )->parse() ) .
145  ( ( $userCanManage || $userCanDelete ) ?
146  Xml::tags( 'th', [ 'class' => 'unsortable' ],
147  $this->msg( 'tags-actions-header' )->parse() ) :
148  '' )
149  );
150 
151  // Used in #doTagRow()
152  $this->softwareActivatedTags = array_fill_keys(
154 
155  // Insert tags that have been applied at least once
156  foreach ( $tagStats as $tag => $hitcount ) {
157  $html .= $this->doTagRow( $tag, $hitcount, $userCanManage,
158  $userCanDelete, $userCanEditInterface );
159  }
160  // Insert tags defined somewhere but never applied
161  foreach ( $definedTags as $tag ) {
162  if ( !isset( $tagStats[$tag] ) ) {
163  $html .= $this->doTagRow( $tag, 0, $userCanManage, $userCanDelete, $userCanEditInterface );
164  }
165  }
166 
167  $out->addHTML( Xml::tags(
168  'table',
169  [ 'class' => 'mw-datatable sortable mw-tags-table' ],
170  $html
171  ) );
172  }
173 
174  function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
175  $newRow = '';
176  $newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
177 
178  $linkRenderer = $this->getLinkRenderer();
179  $disp = ChangeTags::tagDescription( $tag, $this->getContext() );
180  if ( $showEditLinks ) {
181  $disp .= ' ';
182  $editLink = $linkRenderer->makeLink(
183  $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
184  $this->msg( 'tags-edit' )->text()
185  );
186  $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
187  }
188  $newRow .= Xml::tags( 'td', null, $disp );
189 
190  $msg = $this->msg( "tag-$tag-description" );
191  $desc = !$msg->exists() ? '' : $msg->parse();
192  if ( $showEditLinks ) {
193  $desc .= ' ';
194  $editDescLink = $linkRenderer->makeLink(
195  $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
196  $this->msg( 'tags-edit' )->text()
197  );
198  $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
199  }
200  $newRow .= Xml::tags( 'td', null, $desc );
201 
202  $sourceMsgs = [];
203  $isSoftware = isset( $this->softwareDefinedTags[$tag] );
204  $isExplicit = isset( $this->explicitlyDefinedTags[$tag] );
205  if ( $isSoftware ) {
206  // TODO: Rename this message
207  $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
208  }
209  if ( $isExplicit ) {
210  $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
211  }
212  if ( !$sourceMsgs ) {
213  $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
214  }
215  $newRow .= Xml::tags( 'td', null, implode( Xml::element( 'br' ), $sourceMsgs ) );
216 
217  $isActive = $isExplicit || isset( $this->softwareActivatedTags[$tag] );
218  $activeMsg = ( $isActive ? 'tags-active-yes' : 'tags-active-no' );
219  $newRow .= Xml::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
220 
221  $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
222  if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
223  $hitcountLabel = $linkRenderer->makeLink(
224  SpecialPage::getTitleFor( 'Recentchanges' ),
225  $hitcountLabelMsg->text(),
226  [],
227  [ 'tagfilter' => $tag ]
228  );
229  } else {
230  $hitcountLabel = $hitcountLabelMsg->escaped();
231  }
232 
233  // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
234  $newRow .= Xml::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
235 
236  // actions
237  $actionLinks = [];
238 
239  // delete
240  if ( $showDeleteActions && ChangeTags::canDeleteTag( $tag )->isOK() ) {
241  $actionLinks[] = $linkRenderer->makeKnownLink(
242  $this->getPageTitle( 'delete' ),
243  $this->msg( 'tags-delete' )->text(),
244  [],
245  [ 'tag' => $tag ] );
246  }
247 
248  if ( $showManageActions ) { // we've already checked that the user had the requisite userright
249  // activate
250  if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
251  $actionLinks[] = $linkRenderer->makeKnownLink(
252  $this->getPageTitle( 'activate' ),
253  $this->msg( 'tags-activate' )->text(),
254  [],
255  [ 'tag' => $tag ] );
256  }
257 
258  // deactivate
259  if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
260  $actionLinks[] = $linkRenderer->makeKnownLink(
261  $this->getPageTitle( 'deactivate' ),
262  $this->msg( 'tags-deactivate' )->text(),
263  [],
264  [ 'tag' => $tag ] );
265  }
266  }
267 
268  if ( $showDeleteActions || $showManageActions ) {
269  $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
270  }
271 
272  return Xml::tags( 'tr', null, $newRow ) . "\n";
273  }
274 
275  public function processCreateTagForm( array $data, HTMLForm $form ) {
276  $context = $form->getContext();
277  $out = $context->getOutput();
278 
279  $tag = trim( strval( $data['Tag'] ) );
280  $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
281  $status = ChangeTags::createTagWithChecks( $tag, $data['Reason'],
282  $context->getUser(), $ignoreWarnings );
283 
284  if ( $status->isGood() ) {
285  $out->redirect( $this->getPageTitle()->getLocalURL() );
286  return true;
287  } elseif ( $status->isOK() ) {
288  // we have some warnings, so we show a confirmation form
289  $fields = [
290  'Tag' => [
291  'type' => 'hidden',
292  'default' => $data['Tag'],
293  ],
294  'Reason' => [
295  'type' => 'hidden',
296  'default' => $data['Reason'],
297  ],
298  'IgnoreWarnings' => [
299  'type' => 'hidden',
300  'default' => '1',
301  ],
302  ];
303 
304  // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
305  // we get into an infinite loop!
306  $context->getRequest()->unsetVal( 'wpEditToken' );
307 
308  $headerText = $this->msg( 'tags-create-warnings-above', $tag,
309  count( $status->getWarningsArray() ) )->parseAsBlock() .
310  $out->parse( $status->getWikiText() ) .
311  $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
312 
313  $subform = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
314  $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
315  $subform->setWrapperLegendMsg( 'tags-create-heading' );
316  $subform->setHeaderText( $headerText );
317  $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
318  $subform->setSubmitTextMsg( 'htmlform-yes' );
319  $subform->show();
320 
321  $out->addBacklinkSubtitle( $this->getPageTitle() );
322  return true;
323  } else {
324  $out->addWikiText( "<div class=\"error\">\n" . $status->getWikiText() .
325  "\n</div>" );
326  return false;
327  }
328  }
329 
330  protected function showDeleteTagForm( $tag ) {
331  $user = $this->getUser();
332  if ( !$user->isAllowed( 'deletechangetags' ) ) {
333  throw new PermissionsError( 'deletechangetags' );
334  }
335 
336  $out = $this->getOutput();
337  $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
338  $out->addBacklinkSubtitle( $this->getPageTitle() );
339 
340  // is the tag actually able to be deleted?
341  $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
342  if ( !$canDeleteResult->isGood() ) {
343  $out->addWikiText( "<div class=\"error\">\n" . $canDeleteResult->getWikiText() .
344  "\n</div>" );
345  if ( !$canDeleteResult->isOK() ) {
346  return;
347  }
348  }
349 
350  $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
351  $tagUsage = ChangeTags::tagUsageStatistics();
352  if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
353  $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
354  $tagUsage[$tag] )->parseAsBlock();
355  }
356  $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
357 
358  // see if the tag is in use
359  $this->softwareActivatedTags = array_fill_keys(
361  if ( isset( $this->softwareActivatedTags[$tag] ) ) {
362  $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
363  }
364 
365  $fields = [];
366  $fields['Reason'] = [
367  'type' => 'text',
368  'label' => $this->msg( 'tags-delete-reason' )->plain(),
369  'size' => 50,
370  ];
371  $fields['HiddenTag'] = [
372  'type' => 'hidden',
373  'name' => 'tag',
374  'default' => $tag,
375  'required' => true,
376  ];
377 
378  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
379  $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
380  $form->tagAction = 'delete'; // custom property on HTMLForm object
381  $form->setSubmitCallback( [ $this, 'processTagForm' ] );
382  $form->setSubmitTextMsg( 'tags-delete-submit' );
383  $form->setSubmitDestructive(); // nasty!
384  $form->addPreText( $preText );
385  $form->show();
386  }
387 
388  protected function showActivateDeactivateForm( $tag, $activate ) {
389  $actionStr = $activate ? 'activate' : 'deactivate';
390 
391  $user = $this->getUser();
392  if ( !$user->isAllowed( 'managechangetags' ) ) {
393  throw new PermissionsError( 'managechangetags' );
394  }
395 
396  $out = $this->getOutput();
397  // tags-activate-title, tags-deactivate-title
398  $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
399  $out->addBacklinkSubtitle( $this->getPageTitle() );
400 
401  // is it possible to do this?
402  $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
403  $result = ChangeTags::$func( $tag, $user );
404  if ( !$result->isGood() ) {
405  $out->addWikiText( "<div class=\"error\">\n" . $result->getWikiText() .
406  "\n</div>" );
407  if ( !$result->isOK() ) {
408  return;
409  }
410  }
411 
412  // tags-activate-question, tags-deactivate-question
413  $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
414 
415  $fields = [];
416  // tags-activate-reason, tags-deactivate-reason
417  $fields['Reason'] = [
418  'type' => 'text',
419  'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
420  'size' => 50,
421  ];
422  $fields['HiddenTag'] = [
423  'type' => 'hidden',
424  'name' => 'tag',
425  'default' => $tag,
426  'required' => true,
427  ];
428 
429  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
430  $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
431  $form->tagAction = $actionStr;
432  $form->setSubmitCallback( [ $this, 'processTagForm' ] );
433  // tags-activate-submit, tags-deactivate-submit
434  $form->setSubmitTextMsg( "tags-$actionStr-submit" );
435  $form->addPreText( $preText );
436  $form->show();
437  }
438 
439  public function processTagForm( array $data, HTMLForm $form ) {
440  $context = $form->getContext();
441  $out = $context->getOutput();
442 
443  $tag = $data['HiddenTag'];
444  $status = call_user_func( [ ChangeTags::class, "{$form->tagAction}TagWithChecks" ],
445  $tag, $data['Reason'], $context->getUser(), true );
446 
447  if ( $status->isGood() ) {
448  $out->redirect( $this->getPageTitle()->getLocalURL() );
449  return true;
450  } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
451  // deletion succeeded, but hooks raised a warning
452  $out->addWikiText( $this->msg( 'tags-delete-warnings-after-delete', $tag,
453  count( $status->getWarningsArray() ) )->text() . "\n" .
454  $status->getWikitext() );
455  $out->addReturnTo( $this->getPageTitle() );
456  return true;
457  } else {
458  $out->addWikiText( "<div class=\"error\">\n" . $status->getWikitext() .
459  "\n</div>" );
460  return false;
461  }
462  }
463 
469  public function getSubpagesForPrefixSearch() {
470  // The subpages does not have an own form, so not listing it at the moment
471  return [
472  // 'delete',
473  // 'activate',
474  // 'deactivate',
475  // 'create',
476  ];
477  }
478 
479  protected function getGroupName() {
480  return 'changes';
481  }
482 }
$user
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 $user
Definition: hooks.txt:247
SpecialTags
A special page that lists tags for edits.
Definition: SpecialTags.php:29
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:40
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
$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
Xml\tags
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:131
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
array
the array() calling protocol came about after MediaWiki 1.4rc1.
SpecialPage\getTitle
getTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:663
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
SpecialTags\processTagForm
processTagForm(array $data, HTMLForm $form)
Definition: SpecialTags.php:439
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialTags\processCreateTagForm
processCreateTagForm(array $data, HTMLForm $form)
Definition: SpecialTags.php:275
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:752
$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
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
SpecialTags\getSubpagesForPrefixSearch
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
Definition: SpecialTags.php:469
ChangeTags\listSoftwareDefinedTags
static listSoftwareDefinedTags()
Lists tags defined by core or extensions using the ListDefinedTags hook.
Definition: ChangeTags.php:1353
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:279
SpecialTags\$explicitlyDefinedTags
array $explicitlyDefinedTags
List of explicitly defined tags.
Definition: SpecialTags.php:34
SpecialTags\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialTags.php:479
SpecialTags\__construct
__construct()
Definition: SpecialTags.php:46
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
ChangeTags\canActivateTag
static canActivateTag( $tag, User $user=null)
Is it OK to allow the user to activate this tag?
Definition: ChangeTags.php:900
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
ChangeTags\listExplicitlyDefinedTags
static listExplicitlyDefinedTags()
Lists tags explicitly defined in the valid_tag table of the database.
Definition: ChangeTags.php:1320
SpecialTags\showTagList
showTagList()
Definition: SpecialTags.php:73
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
SpecialTags\showActivateDeactivateForm
showActivateDeactivateForm( $tag, $activate)
Definition: SpecialTags.php:388
SpecialTags\doTagRow
doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks)
Definition: SpecialTags.php:174
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
$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
ChangeTags\tagDescription
static tagDescription( $tag, IContextSource $context)
Get a short description for a tag.
Definition: ChangeTags.php:143
ChangeTags\listSoftwareActivatedTags
static listSoftwareActivatedTags()
Lists those tags which core or extensions report as being "active".
Definition: ChangeTags.php:1273
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
SpecialTags\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialTags.php:50
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
SpecialTags\$softwareDefinedTags
array $softwareDefinedTags
List of software defined tags.
Definition: SpecialTags.php:39
SpecialTags\$softwareActivatedTags
array $softwareActivatedTags
List of software activated tags.
Definition: SpecialTags.php:44
SpecialTags\showDeleteTagForm
showDeleteTagForm( $tag)
Definition: SpecialTags.php:330
ChangeTags\tagUsageStatistics
static tagUsageStatistics()
Returns a map of any tags used on the wiki to number of edits tagged with them, ordered descending by...
Definition: ChangeTags.php:1412
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
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
$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
ChangeTags\createTagWithChecks
static createTagWithChecks( $tag, $reason, User $user, $ignoreWarnings=false, array $logEntryTags=[])
Creates a tag by adding a row to the valid_tag table.
Definition: ChangeTags.php:1108
$context
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 and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:629
ChangeTags\canDeleteTag
static canDeleteTag( $tag, User $user=null)
Is it OK to allow the user to delete this tag?
Definition: ChangeTags.php:1189
ChangeTags\canDeactivateTag
static canDeactivateTag( $tag, User $user=null)
Is it OK to allow the user to deactivate this tag?
Definition: ChangeTags.php:972
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130