MediaWiki  1.29.1
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 
250  // activate
251  if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
252  $actionLinks[] = $linkRenderer->makeKnownLink(
253  $this->getPageTitle( 'activate' ),
254  $this->msg( 'tags-activate' )->text(),
255  [],
256  [ 'tag' => $tag ] );
257  }
258 
259  // deactivate
260  if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
261  $actionLinks[] = $linkRenderer->makeKnownLink(
262  $this->getPageTitle( 'deactivate' ),
263  $this->msg( 'tags-deactivate' )->text(),
264  [],
265  [ 'tag' => $tag ] );
266  }
267 
268  }
269 
270  if ( $showDeleteActions || $showManageActions ) {
271  $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
272  }
273 
274  return Xml::tags( 'tr', null, $newRow ) . "\n";
275  }
276 
277  public function processCreateTagForm( array $data, HTMLForm $form ) {
278  $context = $form->getContext();
279  $out = $context->getOutput();
280 
281  $tag = trim( strval( $data['Tag'] ) );
282  $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
283  $status = ChangeTags::createTagWithChecks( $tag, $data['Reason'],
284  $context->getUser(), $ignoreWarnings );
285 
286  if ( $status->isGood() ) {
287  $out->redirect( $this->getPageTitle()->getLocalURL() );
288  return true;
289  } elseif ( $status->isOK() ) {
290  // we have some warnings, so we show a confirmation form
291  $fields = [
292  'Tag' => [
293  'type' => 'hidden',
294  'default' => $data['Tag'],
295  ],
296  'Reason' => [
297  'type' => 'hidden',
298  'default' => $data['Reason'],
299  ],
300  'IgnoreWarnings' => [
301  'type' => 'hidden',
302  'default' => '1',
303  ],
304  ];
305 
306  // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
307  // we get into an infinite loop!
308  $context->getRequest()->unsetVal( 'wpEditToken' );
309 
310  $headerText = $this->msg( 'tags-create-warnings-above', $tag,
311  count( $status->getWarningsArray() ) )->parseAsBlock() .
312  $out->parse( $status->getWikiText() ) .
313  $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
314 
315  $subform = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
316  $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
317  $subform->setWrapperLegendMsg( 'tags-create-heading' );
318  $subform->setHeaderText( $headerText );
319  $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
320  $subform->setSubmitTextMsg( 'htmlform-yes' );
321  $subform->show();
322 
323  $out->addBacklinkSubtitle( $this->getPageTitle() );
324  return true;
325  } else {
326  $out->addWikiText( "<div class=\"error\">\n" . $status->getWikiText() .
327  "\n</div>" );
328  return false;
329  }
330  }
331 
332  protected function showDeleteTagForm( $tag ) {
333  $user = $this->getUser();
334  if ( !$user->isAllowed( 'deletechangetags' ) ) {
335  throw new PermissionsError( 'deletechangetags' );
336  }
337 
338  $out = $this->getOutput();
339  $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
340  $out->addBacklinkSubtitle( $this->getPageTitle() );
341 
342  // is the tag actually able to be deleted?
343  $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
344  if ( !$canDeleteResult->isGood() ) {
345  $out->addWikiText( "<div class=\"error\">\n" . $canDeleteResult->getWikiText() .
346  "\n</div>" );
347  if ( !$canDeleteResult->isOK() ) {
348  return;
349  }
350  }
351 
352  $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
353  $tagUsage = ChangeTags::tagUsageStatistics();
354  if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
355  $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
356  $tagUsage[$tag] )->parseAsBlock();
357  }
358  $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
359 
360  // see if the tag is in use
361  $this->softwareActivatedTags = array_fill_keys(
363  if ( isset( $this->softwareActivatedTags[$tag] ) ) {
364  $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
365  }
366 
367  $fields = [];
368  $fields['Reason'] = [
369  'type' => 'text',
370  'label' => $this->msg( 'tags-delete-reason' )->plain(),
371  'size' => 50,
372  ];
373  $fields['HiddenTag'] = [
374  'type' => 'hidden',
375  'name' => 'tag',
376  'default' => $tag,
377  'required' => true,
378  ];
379 
380  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
381  $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
382  $form->tagAction = 'delete'; // custom property on HTMLForm object
383  $form->setSubmitCallback( [ $this, 'processTagForm' ] );
384  $form->setSubmitTextMsg( 'tags-delete-submit' );
385  $form->setSubmitDestructive(); // nasty!
386  $form->addPreText( $preText );
387  $form->show();
388  }
389 
390  protected function showActivateDeactivateForm( $tag, $activate ) {
391  $actionStr = $activate ? 'activate' : 'deactivate';
392 
393  $user = $this->getUser();
394  if ( !$user->isAllowed( 'managechangetags' ) ) {
395  throw new PermissionsError( 'managechangetags' );
396  }
397 
398  $out = $this->getOutput();
399  // tags-activate-title, tags-deactivate-title
400  $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
401  $out->addBacklinkSubtitle( $this->getPageTitle() );
402 
403  // is it possible to do this?
404  $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
405  $result = ChangeTags::$func( $tag, $user );
406  if ( !$result->isGood() ) {
407  $out->addWikiText( "<div class=\"error\">\n" . $result->getWikiText() .
408  "\n</div>" );
409  if ( !$result->isOK() ) {
410  return;
411  }
412  }
413 
414  // tags-activate-question, tags-deactivate-question
415  $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
416 
417  $fields = [];
418  // tags-activate-reason, tags-deactivate-reason
419  $fields['Reason'] = [
420  'type' => 'text',
421  'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
422  'size' => 50,
423  ];
424  $fields['HiddenTag'] = [
425  'type' => 'hidden',
426  'name' => 'tag',
427  'default' => $tag,
428  'required' => true,
429  ];
430 
431  $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
432  $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
433  $form->tagAction = $actionStr;
434  $form->setSubmitCallback( [ $this, 'processTagForm' ] );
435  // tags-activate-submit, tags-deactivate-submit
436  $form->setSubmitTextMsg( "tags-$actionStr-submit" );
437  $form->addPreText( $preText );
438  $form->show();
439  }
440 
441  public function processTagForm( array $data, HTMLForm $form ) {
442  $context = $form->getContext();
443  $out = $context->getOutput();
444 
445  $tag = $data['HiddenTag'];
446  $status = call_user_func( [ 'ChangeTags', "{$form->tagAction}TagWithChecks" ],
447  $tag, $data['Reason'], $context->getUser(), true );
448 
449  if ( $status->isGood() ) {
450  $out->redirect( $this->getPageTitle()->getLocalURL() );
451  return true;
452  } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
453  // deletion succeeded, but hooks raised a warning
454  $out->addWikiText( $this->msg( 'tags-delete-warnings-after-delete', $tag,
455  count( $status->getWarningsArray() ) )->text() . "\n" .
456  $status->getWikitext() );
457  $out->addReturnTo( $this->getPageTitle() );
458  return true;
459  } else {
460  $out->addWikiText( "<div class=\"error\">\n" . $status->getWikitext() .
461  "\n</div>" );
462  return false;
463  }
464  }
465 
471  public function getSubpagesForPrefixSearch() {
472  // The subpages does not have an own form, so not listing it at the moment
473  return [
474  // 'delete',
475  // 'activate',
476  // 'deactivate',
477  // 'create',
478  ];
479  }
480 
481  protected function getGroupName() {
482  return 'changes';
483  }
484 }
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:628
$context
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2612
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:41
$request
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2612
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
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:675
SpecialPage\getTitle
getTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:617
captcha-old.count
count
Definition: captcha-old.py:225
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:12
$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. '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 '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:1954
SpecialTags\processTagForm
processTagForm(array $data, HTMLForm $form)
Definition: SpecialTags.php:441
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
$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:246
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:277
ContextSource\getRequest
getRequest()
Get the WebRequest object.
Definition: ContextSource.php:78
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:705
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
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:35
SpecialTags\getSubpagesForPrefixSearch
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
Definition: SpecialTags.php:471
ChangeTags\listSoftwareDefinedTags
static listSoftwareDefinedTags()
Lists tags defined by core or extensions using the ListDefinedTags hook.
Definition: ChangeTags.php:1244
$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:1956
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
$tag
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books $tag
Definition: hooks.txt:1028
ContextSource\getOutput
getOutput()
Get the OutputPage object.
Definition: ContextSource.php:123
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:277
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:481
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:484
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
ChangeTags\canActivateTag
static canActivateTag( $tag, User $user=null)
Is it OK to allow the user to activate this tag?
Definition: ChangeTags.php:801
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:648
ChangeTags\listExplicitlyDefinedTags
static listExplicitlyDefinedTags()
Lists tags explicitly defined in the valid_tag table of the database.
Definition: ChangeTags.php:1212
SpecialTags\showTagList
showTagList()
Definition: SpecialTags.php:73
SpecialPage\msg
msg()
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
SpecialTags\showActivateDeactivateForm
showActivateDeactivateForm( $tag, $activate)
Definition: SpecialTags.php:390
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:665
ChangeTags\tagDescription
static tagDescription( $tag, IContextSource $context)
Get a short description for a tag.
Definition: ChangeTags.php:107
ChangeTags\listSoftwareActivatedTags
static listSoftwareActivatedTags()
Lists those tags which core or extensions report as being "active".
Definition: ChangeTags.php:1155
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:856
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:9
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
true
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 true
Definition: hooks.txt:1956
SpecialTags\showDeleteTagForm
showDeleteTagForm( $tag)
Definition: SpecialTags.php:332
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:1313
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
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:990
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:583
ChangeTags\canDeleteTag
static canDeleteTag( $tag, User $user=null)
Is it OK to allow the user to delete this tag?
Definition: ChangeTags.php:1071
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ChangeTags\canDeactivateTag
static canDeactivateTag( $tag, User $user=null)
Is it OK to allow the user to deactivate this tag?
Definition: ChangeTags.php:873
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:128
$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:783