MediaWiki  1.28.0
SkinTemplate.php
Go to the documentation of this file.
1 <?php
23 
38 class SkinTemplate extends Skin {
43  public $skinname = 'monobook';
44 
49  public $template = 'QuickTemplate';
50 
51  public $thispage;
52  public $titletxt;
53  public $userpage;
54  public $thisquery;
55  public $loggedin;
56  public $username;
58 
65  $moduleStyles = [
66  'mediawiki.legacy.shared',
67  'mediawiki.legacy.commonPrint',
68  'mediawiki.sectionAnchor'
69  ];
70  if ( $out->isSyndicated() ) {
71  $moduleStyles[] = 'mediawiki.feedlink';
72  }
73 
74  // Deprecated since 1.26: Unconditional loading of mediawiki.ui.button
75  // on every page is deprecated. Express a dependency instead.
76  if ( strpos( $out->getHTML(), 'mw-ui-button' ) !== false ) {
77  $moduleStyles[] = 'mediawiki.ui.button';
78  }
79 
80  $out->addModuleStyles( $moduleStyles );
81  }
82 
94  function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
95  return new $classname( $this->getConfig() );
96  }
97 
103  public function getLanguages() {
105  if ( $wgHideInterlanguageLinks ) {
106  return [];
107  }
108 
109  $userLang = $this->getLanguage();
110  $languageLinks = [];
111 
112  foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
113  $class = 'interlanguage-link interwiki-' . explode( ':', $languageLinkText, 2 )[0];
114 
115  $languageLinkTitle = Title::newFromText( $languageLinkText );
116  if ( $languageLinkTitle ) {
117  $ilInterwikiCode = $languageLinkTitle->getInterwiki();
118  $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
119 
120  if ( strval( $ilLangName ) === '' ) {
121  $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
122  if ( !$ilDisplayTextMsg->isDisabled() ) {
123  // Use custom MW message for the display text
124  $ilLangName = $ilDisplayTextMsg->text();
125  } else {
126  // Last resort: fallback to the language link target
127  $ilLangName = $languageLinkText;
128  }
129  } else {
130  // Use the language autonym as display text
131  $ilLangName = $this->formatLanguageName( $ilLangName );
132  }
133 
134  // CLDR extension or similar is required to localize the language name;
135  // otherwise we'll end up with the autonym again.
136  $ilLangLocalName = Language::fetchLanguageName(
137  $ilInterwikiCode,
138  $userLang->getCode()
139  );
140 
141  $languageLinkTitleText = $languageLinkTitle->getText();
142  if ( $ilLangLocalName === '' ) {
143  $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
144  if ( !$ilFriendlySiteName->isDisabled() ) {
145  if ( $languageLinkTitleText === '' ) {
146  $ilTitle = wfMessage(
147  'interlanguage-link-title-nonlangonly',
148  $ilFriendlySiteName->text()
149  )->text();
150  } else {
151  $ilTitle = wfMessage(
152  'interlanguage-link-title-nonlang',
153  $languageLinkTitleText,
154  $ilFriendlySiteName->text()
155  )->text();
156  }
157  } else {
158  // we have nothing friendly to put in the title, so fall back to
159  // displaying the interlanguage link itself in the title text
160  // (similar to what is done in page content)
161  $ilTitle = $languageLinkTitle->getInterwiki() .
162  ":$languageLinkTitleText";
163  }
164  } elseif ( $languageLinkTitleText === '' ) {
165  $ilTitle = wfMessage(
166  'interlanguage-link-title-langonly',
167  $ilLangLocalName
168  )->text();
169  } else {
170  $ilTitle = wfMessage(
171  'interlanguage-link-title',
172  $languageLinkTitleText,
173  $ilLangLocalName
174  )->text();
175  }
176 
177  $ilInterwikiCodeBCP47 = wfBCP47( $ilInterwikiCode );
178  $languageLink = [
179  'href' => $languageLinkTitle->getFullURL(),
180  'text' => $ilLangName,
181  'title' => $ilTitle,
182  'class' => $class,
183  'link-class' => 'interlanguage-link-target',
184  'lang' => $ilInterwikiCodeBCP47,
185  'hreflang' => $ilInterwikiCodeBCP47,
186  ];
187  Hooks::run(
188  'SkinTemplateGetLanguageLink',
189  [ &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() ]
190  );
191  $languageLinks[] = $languageLink;
192  }
193  }
194 
195  return $languageLinks;
196  }
197 
198  protected function setupTemplateForOutput() {
199 
200  $request = $this->getRequest();
201  $user = $this->getUser();
202  $title = $this->getTitle();
203 
204  $tpl = $this->setupTemplate( $this->template, 'skins' );
205 
206  $this->thispage = $title->getPrefixedDBkey();
207  $this->titletxt = $title->getPrefixedText();
208  $this->userpage = $user->getUserPage()->getPrefixedText();
209  $query = [];
210  if ( !$request->wasPosted() ) {
211  $query = $request->getValues();
212  unset( $query['title'] );
213  unset( $query['returnto'] );
214  unset( $query['returntoquery'] );
215  }
216  $this->thisquery = wfArrayToCgi( $query );
217  $this->loggedin = $user->isLoggedIn();
218  $this->username = $user->getName();
219 
220  if ( $this->loggedin ) {
221  $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
222  } else {
223  # This won't be used in the standard skins, but we define it to preserve the interface
224  # To save time, we check for existence
225  $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
226  }
227 
228  return $tpl;
229  }
230 
236  function outputPage( OutputPage $out = null ) {
237  Profiler::instance()->setTemplated( true );
238 
239  $oldContext = null;
240  if ( $out !== null ) {
241  // Deprecated since 1.20, note added in 1.25
242  wfDeprecated( __METHOD__, '1.25' );
243  $oldContext = $this->getContext();
244  $this->setContext( $out->getContext() );
245  }
246 
247  $out = $this->getOutput();
248 
249  $this->initPage( $out );
250  $tpl = $this->prepareQuickTemplate();
251  // execute template
252  $res = $tpl->execute();
253 
254  // result may be an error
255  $this->printOrError( $res );
256 
257  if ( $oldContext ) {
258  $this->setContext( $oldContext );
259  }
260 
261  }
262 
270  protected function wrapHTML( $title, $html ) {
271  # An ID that includes the actual body text; without categories, contentSub, ...
272  $realBodyAttribs = [ 'id' => 'mw-content-text' ];
273 
274  # Add a mw-content-ltr/rtl class to be able to style based on text direction
275  # when the content is different from the UI language, i.e.:
276  # not for special pages or file pages AND only when viewing
277  if ( !in_array( $title->getNamespace(), [ NS_SPECIAL, NS_FILE ] ) &&
278  Action::getActionName( $this ) === 'view' ) {
279  $pageLang = $title->getPageViewLanguage();
280  $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
281  $realBodyAttribs['dir'] = $pageLang->getDir();
282  $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
283  }
284 
285  return Html::rawElement( 'div', $realBodyAttribs, $html );
286  }
287 
294  protected function prepareQuickTemplate() {
296  $wgSitename, $wgLogo, $wgMaxCredits,
297  $wgShowCreditsIfMax, $wgArticlePath,
299 
300  $title = $this->getTitle();
301  $request = $this->getRequest();
302  $out = $this->getOutput();
303  $tpl = $this->setupTemplateForOutput();
304 
305  $tpl->set( 'title', $out->getPageTitle() );
306  $tpl->set( 'pagetitle', $out->getHTMLTitle() );
307  $tpl->set( 'displaytitle', $out->mPageLinkTitle );
308 
309  $tpl->setRef( 'thispage', $this->thispage );
310  $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
311  $tpl->set( 'titletext', $title->getText() );
312  $tpl->set( 'articleid', $title->getArticleID() );
313 
314  $tpl->set( 'isarticle', $out->isArticle() );
315 
316  $subpagestr = $this->subPageSubtitle();
317  if ( $subpagestr !== '' ) {
318  $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
319  }
320  $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
321 
322  $undelete = $this->getUndeleteLink();
323  if ( $undelete === '' ) {
324  $tpl->set( 'undelete', '' );
325  } else {
326  $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
327  }
328 
329  $tpl->set( 'catlinks', $this->getCategories() );
330  if ( $out->isSyndicated() ) {
331  $feeds = [];
332  foreach ( $out->getSyndicationLinks() as $format => $link ) {
333  $feeds[$format] = [
334  // Messages: feed-atom, feed-rss
335  'text' => $this->msg( "feed-$format" )->text(),
336  'href' => $link
337  ];
338  }
339  $tpl->setRef( 'feeds', $feeds );
340  } else {
341  $tpl->set( 'feeds', false );
342  }
343 
344  $tpl->setRef( 'mimetype', $wgMimeType );
345  $tpl->setRef( 'jsmimetype', $wgJsMimeType );
346  $tpl->set( 'charset', 'UTF-8' );
347  $tpl->setRef( 'wgScript', $wgScript );
348  $tpl->setRef( 'skinname', $this->skinname );
349  $tpl->set( 'skinclass', get_class( $this ) );
350  $tpl->setRef( 'skin', $this );
351  $tpl->setRef( 'stylename', $this->stylename );
352  $tpl->set( 'printable', $out->isPrintable() );
353  $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
354  $tpl->setRef( 'loggedin', $this->loggedin );
355  $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
356  $tpl->set( 'searchaction', $this->escapeSearchLink() );
357  $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
358  $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
359  $tpl->setRef( 'stylepath', $wgStylePath );
360  $tpl->setRef( 'articlepath', $wgArticlePath );
361  $tpl->setRef( 'scriptpath', $wgScriptPath );
362  $tpl->setRef( 'serverurl', $wgServer );
363  $tpl->setRef( 'logopath', $wgLogo );
364  $tpl->setRef( 'sitename', $wgSitename );
365 
366  $userLang = $this->getLanguage();
367  $userLangCode = $userLang->getHtmlCode();
368  $userLangDir = $userLang->getDir();
369 
370  $tpl->set( 'lang', $userLangCode );
371  $tpl->set( 'dir', $userLangDir );
372  $tpl->set( 'rtl', $userLang->isRTL() );
373 
374  $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
375  $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
376  $tpl->set( 'username', $this->loggedin ? $this->username : null );
377  $tpl->setRef( 'userpage', $this->userpage );
378  $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
379  $tpl->set( 'userlang', $userLangCode );
380 
381  // Users can have their language set differently than the
382  // content of the wiki. For these users, tell the web browser
383  // that interface elements are in a different language.
384  $tpl->set( 'userlangattributes', '' );
385  $tpl->set( 'specialpageattributes', '' ); # obsolete
386  // Used by VectorBeta to insert HTML before content but after the
387  // heading for the page title. Defaults to empty string.
388  $tpl->set( 'prebodyhtml', '' );
389 
390  if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
391  $escUserlang = htmlspecialchars( $userLangCode );
392  $escUserdir = htmlspecialchars( $userLangDir );
393  // Attributes must be in double quotes because htmlspecialchars() doesn't
394  // escape single quotes
395  $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
396  $tpl->set( 'userlangattributes', $attrs );
397  }
398 
399  $tpl->set( 'newtalk', $this->getNewtalks() );
400  $tpl->set( 'logo', $this->logoText() );
401 
402  $tpl->set( 'copyright', false );
403  // No longer used
404  $tpl->set( 'viewcount', false );
405  $tpl->set( 'lastmod', false );
406  $tpl->set( 'credits', false );
407  $tpl->set( 'numberofwatchingusers', false );
408  if ( $out->isArticle() && $title->exists() ) {
409  if ( $this->isRevisionCurrent() ) {
410  if ( $wgMaxCredits != 0 ) {
411  $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
412  $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
413  } else {
414  $tpl->set( 'lastmod', $this->lastModified() );
415  }
416  }
417  $tpl->set( 'copyright', $this->getCopyright() );
418  }
419 
420  $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
421  $tpl->set( 'poweredbyico', $this->getPoweredBy() );
422  $tpl->set( 'disclaimer', $this->disclaimerLink() );
423  $tpl->set( 'privacy', $this->privacyLink() );
424  $tpl->set( 'about', $this->aboutLink() );
425 
426  $tpl->set( 'footerlinks', [
427  'info' => [
428  'lastmod',
429  'numberofwatchingusers',
430  'credits',
431  'copyright',
432  ],
433  'places' => [
434  'privacy',
435  'about',
436  'disclaimer',
437  ],
438  ] );
439 
441  $tpl->set( 'footericons', $wgFooterIcons );
442  foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
443  if ( count( $footerIconsBlock ) > 0 ) {
444  foreach ( $footerIconsBlock as &$footerIcon ) {
445  if ( isset( $footerIcon['src'] ) ) {
446  if ( !isset( $footerIcon['width'] ) ) {
447  $footerIcon['width'] = 88;
448  }
449  if ( !isset( $footerIcon['height'] ) ) {
450  $footerIcon['height'] = 31;
451  }
452  }
453  }
454  } else {
455  unset( $tpl->data['footericons'][$footerIconsKey] );
456  }
457  }
458 
459  $tpl->set( 'indicators', $out->getIndicators() );
460 
461  $tpl->set( 'sitenotice', $this->getSiteNotice() );
462  $tpl->set( 'printfooter', $this->printSource() );
463  // Wrap the bodyText with #mw-content-text element
464  $out->mBodytext = $this->wrapHTML( $title, $out->mBodytext );
465  $tpl->setRef( 'bodytext', $out->mBodytext );
466 
467  $language_urls = $this->getLanguages();
468  if ( count( $language_urls ) ) {
469  $tpl->setRef( 'language_urls', $language_urls );
470  } else {
471  $tpl->set( 'language_urls', false );
472  }
473 
474  # Personal toolbar
475  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
476  $content_navigation = $this->buildContentNavigationUrls();
477  $content_actions = $this->buildContentActionUrls( $content_navigation );
478  $tpl->setRef( 'content_navigation', $content_navigation );
479  $tpl->setRef( 'content_actions', $content_actions );
480 
481  $tpl->set( 'sidebar', $this->buildSidebar() );
482  $tpl->set( 'nav_urls', $this->buildNavUrls() );
483 
484  // Do this last in case hooks above add bottom scripts
485  $tpl->set( 'bottomscripts', $this->bottomScripts() );
486 
487  // Set the head scripts near the end, in case the above actions resulted in added scripts
488  $tpl->set( 'headelement', $out->headElement( $this ) );
489 
490  $tpl->set( 'debug', '' );
491  $tpl->set( 'debughtml', $this->generateDebugHTML() );
492  $tpl->set( 'reporttime', wfReportTime() );
493 
494  // original version by hansm
495  if ( !Hooks::run( 'SkinTemplateOutputPageBeforeExec', [ &$this, &$tpl ] ) ) {
496  wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
497  }
498 
499  // Set the bodytext to another key so that skins can just output it on its own
500  // and output printfooter and debughtml separately
501  $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
502 
503  // Append printfooter and debughtml onto bodytext so that skins that
504  // were already using bodytext before they were split out don't suddenly
505  // start not outputting information.
506  $tpl->data['bodytext'] .= Html::rawElement(
507  'div',
508  [ 'class' => 'printfooter' ],
509  "\n{$tpl->data['printfooter']}"
510  ) . "\n";
511  $tpl->data['bodytext'] .= $tpl->data['debughtml'];
512 
513  // allow extensions adding stuff after the page content.
514  // See Skin::afterContentHook() for further documentation.
515  $tpl->set( 'dataAfterContent', $this->afterContentHook() );
516 
517  return $tpl;
518  }
519 
524  public function getPersonalToolsList() {
525  $tpl = $this->setupTemplateForOutput();
526  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
527  $html = '';
528  foreach ( $tpl->getPersonalTools() as $key => $item ) {
529  $html .= $tpl->makeListItem( $key, $item );
530  }
531  return $html;
532  }
533 
542  function formatLanguageName( $name ) {
543  return $this->getLanguage()->ucfirst( $name );
544  }
545 
554  function printOrError( $str ) {
555  echo $str;
556  }
557 
567  function useCombinedLoginLink() {
570  }
571 
576  protected function buildPersonalUrls() {
577  $title = $this->getTitle();
578  $request = $this->getRequest();
579  $pageurl = $title->getLocalURL();
580  $authManager = AuthManager::singleton();
581 
582  /* set up the default links for the personal toolbar */
583  $personal_urls = [];
584 
585  # Due to bug 32276, if a user does not have read permissions,
586  # $this->getTitle() will just give Special:Badtitle, which is
587  # not especially useful as a returnto parameter. Use the title
588  # from the request instead, if there was one.
589  if ( $this->getUser()->isAllowed( 'read' ) ) {
590  $page = $this->getTitle();
591  } else {
592  $page = Title::newFromText( $request->getVal( 'title', '' ) );
593  }
594  $page = $request->getVal( 'returnto', $page );
595  $a = [];
596  if ( strval( $page ) !== '' ) {
597  $a['returnto'] = $page;
598  $query = $request->getVal( 'returntoquery', $this->thisquery );
599  if ( $query != '' ) {
600  $a['returntoquery'] = $query;
601  }
602  }
603 
604  $returnto = wfArrayToCgi( $a );
605  if ( $this->loggedin ) {
606  $personal_urls['userpage'] = [
607  'text' => $this->username,
608  'href' => &$this->userpageUrlDetails['href'],
609  'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
610  'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
611  'dir' => 'auto'
612  ];
613  $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
614  $personal_urls['mytalk'] = [
615  'text' => $this->msg( 'mytalk' )->text(),
616  'href' => &$usertalkUrlDetails['href'],
617  'class' => $usertalkUrlDetails['exists'] ? false : 'new',
618  'active' => ( $usertalkUrlDetails['href'] == $pageurl )
619  ];
620  $href = self::makeSpecialUrl( 'Preferences' );
621  $personal_urls['preferences'] = [
622  'text' => $this->msg( 'mypreferences' )->text(),
623  'href' => $href,
624  'active' => ( $href == $pageurl )
625  ];
626 
627  if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
628  $href = self::makeSpecialUrl( 'Watchlist' );
629  $personal_urls['watchlist'] = [
630  'text' => $this->msg( 'mywatchlist' )->text(),
631  'href' => $href,
632  'active' => ( $href == $pageurl )
633  ];
634  }
635 
636  # We need to do an explicit check for Special:Contributions, as we
637  # have to match both the title, and the target, which could come
638  # from request values (Special:Contributions?target=Jimbo_Wales)
639  # or be specified in "sub page" form
640  # (Special:Contributions/Jimbo_Wales). The plot
641  # thickens, because the Title object is altered for special pages,
642  # so it doesn't contain the original alias-with-subpage.
643  $origTitle = Title::newFromText( $request->getText( 'title' ) );
644  if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
645  list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
646  $active = $spName == 'Contributions'
647  && ( ( $spPar && $spPar == $this->username )
648  || $request->getText( 'target' ) == $this->username );
649  } else {
650  $active = false;
651  }
652 
653  $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
654  $personal_urls['mycontris'] = [
655  'text' => $this->msg( 'mycontris' )->text(),
656  'href' => $href,
657  'active' => $active
658  ];
659 
660  // if we can't set the user, we can't unset it either
661  if ( $request->getSession()->canSetUser() ) {
662  $personal_urls['logout'] = [
663  'text' => $this->msg( 'pt-userlogout' )->text(),
664  'href' => self::makeSpecialUrl( 'Userlogout',
665  // userlogout link must always contain an & character, otherwise we might not be able
666  // to detect a buggy precaching proxy (bug 17790)
667  $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto ),
668  'active' => false
669  ];
670  }
671  } else {
672  $useCombinedLoginLink = $this->useCombinedLoginLink();
673  if ( !$authManager->canCreateAccounts() || !$authManager->canAuthenticateNow() ) {
674  // don't show combined login/signup link if one of those is actually not available
675  $useCombinedLoginLink = false;
676  }
677 
678  $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
679  ? 'nav-login-createaccount'
680  : 'pt-login';
681 
682  $login_url = [
683  'text' => $this->msg( $loginlink )->text(),
684  'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
685  'active' => $title->isSpecial( 'Userlogin' )
686  || $title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink,
687  ];
688  $createaccount_url = [
689  'text' => $this->msg( 'pt-createaccount' )->text(),
690  'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ),
691  'active' => $title->isSpecial( 'CreateAccount' ),
692  ];
693 
694  // No need to show Talk and Contributions to anons if they can't contribute!
695  if ( User::groupHasPermission( '*', 'edit' ) ) {
696  // Because of caching, we can't link directly to the IP talk and
697  // contributions pages. Instead we use the special page shortcuts
698  // (which work correctly regardless of caching). This means we can't
699  // determine whether these links are active or not, but since major
700  // skins (MonoBook, Vector) don't use this information, it's not a
701  // huge loss.
702  $personal_urls['anontalk'] = [
703  'text' => $this->msg( 'anontalk' )->text(),
704  'href' => self::makeSpecialUrlSubpage( 'Mytalk', false ),
705  'active' => false
706  ];
707  $personal_urls['anoncontribs'] = [
708  'text' => $this->msg( 'anoncontribs' )->text(),
709  'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ),
710  'active' => false
711  ];
712  }
713 
714  if (
715  $authManager->canCreateAccounts()
716  && $this->getUser()->isAllowed( 'createaccount' )
717  && !$useCombinedLoginLink
718  ) {
719  $personal_urls['createaccount'] = $createaccount_url;
720  }
721 
722  if ( $authManager->canAuthenticateNow() ) {
723  $personal_urls['login'] = $login_url;
724  }
725  }
726 
727  Hooks::run( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
728  return $personal_urls;
729  }
730 
742  function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
743  $classes = [];
744  if ( $selected ) {
745  $classes[] = 'selected';
746  }
747  if ( $checkEdit && !$title->isKnown() ) {
748  $classes[] = 'new';
749  if ( $query !== '' ) {
750  $query = 'action=edit&redlink=1&' . $query;
751  } else {
752  $query = 'action=edit&redlink=1';
753  }
754  }
755 
756  $linkClass = MediaWikiServices::getInstance()->getLinkRenderer()->getLinkClasses( $title );
757 
758  // wfMessageFallback will nicely accept $message as an array of fallbacks
759  // or just a single key
760  $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
761  if ( is_array( $message ) ) {
762  // for hook compatibility just keep the last message name
763  $message = end( $message );
764  }
765  if ( $msg->exists() ) {
766  $text = $msg->text();
767  } else {
769  $text = $wgContLang->getConverter()->convertNamespace(
770  MWNamespace::getSubject( $title->getNamespace() ) );
771  }
772 
773  $result = [];
774  if ( !Hooks::run( 'SkinTemplateTabAction', [ &$this,
775  $title, $message, $selected, $checkEdit,
776  &$classes, &$query, &$text, &$result ] ) ) {
777  return $result;
778  }
779 
780  $result = [
781  'class' => implode( ' ', $classes ),
782  'text' => $text,
783  'href' => $title->getLocalURL( $query ),
784  'primary' => true ];
785  if ( $linkClass !== '' ) {
786  $result['link-class'] = $linkClass;
787  }
788 
789  return $result;
790  }
791 
792  function makeTalkUrlDetails( $name, $urlaction = '' ) {
794  if ( !is_object( $title ) ) {
795  throw new MWException( __METHOD__ . " given invalid pagename $name" );
796  }
797  $title = $title->getTalkPage();
798  self::checkTitle( $title, $name );
799  return [
800  'href' => $title->getLocalURL( $urlaction ),
801  'exists' => $title->isKnown(),
802  ];
803  }
804 
808  function makeArticleUrlDetails( $name, $urlaction = '' ) {
810  $title = $title->getSubjectPage();
811  self::checkTitle( $title, $name );
812  return [
813  'href' => $title->getLocalURL( $urlaction ),
814  'exists' => $title->exists(),
815  ];
816  }
817 
852  protected function buildContentNavigationUrls() {
854 
855  // Display tabs for the relevant title rather than always the title itself
856  $title = $this->getRelevantTitle();
857  $onPage = $title->equals( $this->getTitle() );
858 
859  $out = $this->getOutput();
860  $request = $this->getRequest();
861  $user = $this->getUser();
862 
863  $content_navigation = [
864  'namespaces' => [],
865  'views' => [],
866  'actions' => [],
867  'variants' => []
868  ];
869 
870  // parameters
871  $action = $request->getVal( 'action', 'view' );
872 
873  $userCanRead = $title->quickUserCan( 'read', $user );
874 
875  $preventActiveTabs = false;
876  Hooks::run( 'SkinTemplatePreventOtherActiveTabs', [ &$this, &$preventActiveTabs ] );
877 
878  // Checks if page is some kind of content
879  if ( $title->canExist() ) {
880  // Gets page objects for the related namespaces
881  $subjectPage = $title->getSubjectPage();
882  $talkPage = $title->getTalkPage();
883 
884  // Determines if this is a talk page
885  $isTalk = $title->isTalkPage();
886 
887  // Generates XML IDs from namespace names
888  $subjectId = $title->getNamespaceKey( '' );
889 
890  if ( $subjectId == 'main' ) {
891  $talkId = 'talk';
892  } else {
893  $talkId = "{$subjectId}_talk";
894  }
895 
896  $skname = $this->skinname;
897 
898  // Adds namespace links
899  $subjectMsg = [ "nstab-$subjectId" ];
900  if ( $subjectPage->isMainPage() ) {
901  array_unshift( $subjectMsg, 'mainpage-nstab' );
902  }
903  $content_navigation['namespaces'][$subjectId] = $this->tabAction(
904  $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
905  );
906  $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
907  $content_navigation['namespaces'][$talkId] = $this->tabAction(
908  $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
909  );
910  $content_navigation['namespaces'][$talkId]['context'] = 'talk';
911 
912  if ( $userCanRead ) {
913  // Adds "view" view link
914  if ( $title->isKnown() ) {
915  $content_navigation['views']['view'] = $this->tabAction(
916  $isTalk ? $talkPage : $subjectPage,
917  [ "$skname-view-view", 'view' ],
918  ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
919  );
920  // signal to hide this from simple content_actions
921  $content_navigation['views']['view']['redundant'] = true;
922  }
923 
924  $isForeignFile = $title->inNamespace( NS_FILE ) && $this->canUseWikiPage() &&
925  $this->getWikiPage() instanceof WikiFilePage && !$this->getWikiPage()->isLocal();
926 
927  // If it is a non-local file, show a link to the file in its own repository
928  // @todo abstract this for remote content that isn't a file
929  if ( $isForeignFile ) {
930  $file = $this->getWikiPage()->getFile();
931  $content_navigation['views']['view-foreign'] = [
932  'class' => '',
933  'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
934  setContext( $this->getContext() )->
935  params( $file->getRepo()->getDisplayName() )->text(),
936  'href' => $file->getDescriptionUrl(),
937  'primary' => false,
938  ];
939  }
940 
941  // Checks if user can edit the current page if it exists or create it otherwise
942  if ( $title->quickUserCan( 'edit', $user )
943  && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
944  ) {
945  // Builds CSS class for talk page links
946  $isTalkClass = $isTalk ? ' istalk' : '';
947  // Whether the user is editing the page
948  $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
949  // Whether to show the "Add a new section" tab
950  // Checks if this is a current rev of talk page and is not forced to be hidden
951  $showNewSection = !$out->forceHideNewSectionLink()
952  && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
953  $section = $request->getVal( 'section' );
954 
955  if ( $title->exists()
956  || ( $title->getNamespace() == NS_MEDIAWIKI
957  && $title->getDefaultMessageText() !== false
958  )
959  ) {
960  $msgKey = $isForeignFile ? 'edit-local' : 'edit';
961  } else {
962  $msgKey = $isForeignFile ? 'create-local' : 'create';
963  }
964  $content_navigation['views']['edit'] = [
965  'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
966  ? 'selected'
967  : ''
968  ) . $isTalkClass,
969  'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
970  ->setContext( $this->getContext() )->text(),
971  'href' => $title->getLocalURL( $this->editUrlOptions() ),
972  'primary' => !$isForeignFile, // don't collapse this in vector
973  ];
974 
975  // section link
976  if ( $showNewSection ) {
977  // Adds new section link
978  // $content_navigation['actions']['addsection']
979  $content_navigation['views']['addsection'] = [
980  'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
981  'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
982  ->setContext( $this->getContext() )->text(),
983  'href' => $title->getLocalURL( 'action=edit&section=new' )
984  ];
985  }
986  // Checks if the page has some kind of viewable source content
987  } elseif ( $title->hasSourceText() ) {
988  // Adds view source view link
989  $content_navigation['views']['viewsource'] = [
990  'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
991  'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
992  ->setContext( $this->getContext() )->text(),
993  'href' => $title->getLocalURL( $this->editUrlOptions() ),
994  'primary' => true, // don't collapse this in vector
995  ];
996  }
997 
998  // Checks if the page exists
999  if ( $title->exists() ) {
1000  // Adds history view link
1001  $content_navigation['views']['history'] = [
1002  'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
1003  'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
1004  ->setContext( $this->getContext() )->text(),
1005  'href' => $title->getLocalURL( 'action=history' ),
1006  ];
1007 
1008  if ( $title->quickUserCan( 'delete', $user ) ) {
1009  $content_navigation['actions']['delete'] = [
1010  'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
1011  'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1012  ->setContext( $this->getContext() )->text(),
1013  'href' => $title->getLocalURL( 'action=delete' )
1014  ];
1015  }
1016 
1017  if ( $title->quickUserCan( 'move', $user ) ) {
1018  $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1019  $content_navigation['actions']['move'] = [
1020  'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1021  'text' => wfMessageFallback( "$skname-action-move", 'move' )
1022  ->setContext( $this->getContext() )->text(),
1023  'href' => $moveTitle->getLocalURL()
1024  ];
1025  }
1026  } else {
1027  // article doesn't exist or is deleted
1028  if ( $user->isAllowed( 'deletedhistory' ) ) {
1029  $n = $title->isDeleted();
1030  if ( $n ) {
1031  $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1032  // If the user can't undelete but can view deleted
1033  // history show them a "View .. deleted" tab instead.
1034  $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1035  $content_navigation['actions']['undelete'] = [
1036  'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1037  'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1038  ->setContext( $this->getContext() )->numParams( $n )->text(),
1039  'href' => $undelTitle->getLocalURL()
1040  ];
1041  }
1042  }
1043  }
1044 
1045  if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1046  MWNamespace::getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1047  ) {
1048  $mode = $title->isProtected() ? 'unprotect' : 'protect';
1049  $content_navigation['actions'][$mode] = [
1050  'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1051  'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1052  ->setContext( $this->getContext() )->text(),
1053  'href' => $title->getLocalURL( "action=$mode" )
1054  ];
1055  }
1056 
1057  // Checks if the user is logged in
1058  if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1068  $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1069  $content_navigation['actions'][$mode] = [
1070  'class' => 'mw-watchlink ' . (
1071  $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : ''
1072  ),
1073  // uses 'watch' or 'unwatch' message
1074  'text' => $this->msg( $mode )->text(),
1075  'href' => $title->getLocalURL( [ 'action' => $mode ] )
1076  ];
1077  }
1078  }
1079 
1080  Hooks::run( 'SkinTemplateNavigation', [ &$this, &$content_navigation ] );
1081 
1082  if ( $userCanRead && !$wgDisableLangConversion ) {
1083  $pageLang = $title->getPageLanguage();
1084  // Gets list of language variants
1085  $variants = $pageLang->getVariants();
1086  // Checks that language conversion is enabled and variants exist
1087  // And if it is not in the special namespace
1088  if ( count( $variants ) > 1 ) {
1089  // Gets preferred variant (note that user preference is
1090  // only possible for wiki content language variant)
1091  $preferred = $pageLang->getPreferredVariant();
1092  if ( Action::getActionName( $this ) === 'view' ) {
1093  $params = $request->getQueryValues();
1094  unset( $params['title'] );
1095  } else {
1096  $params = [];
1097  }
1098  // Loops over each variant
1099  foreach ( $variants as $code ) {
1100  // Gets variant name from language code
1101  $varname = $pageLang->getVariantname( $code );
1102  // Appends variant link
1103  $content_navigation['variants'][] = [
1104  'class' => ( $code == $preferred ) ? 'selected' : false,
1105  'text' => $varname,
1106  'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ),
1107  'lang' => wfBCP47( $code ),
1108  'hreflang' => wfBCP47( $code ),
1109  ];
1110  }
1111  }
1112  }
1113  } else {
1114  // If it's not content, it's got to be a special page
1115  $content_navigation['namespaces']['special'] = [
1116  'class' => 'selected',
1117  'text' => $this->msg( 'nstab-special' )->text(),
1118  'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1119  'context' => 'subject'
1120  ];
1121 
1122  Hooks::run( 'SkinTemplateNavigation::SpecialPage',
1123  [ &$this, &$content_navigation ] );
1124  }
1125 
1126  // Equiv to SkinTemplateContentActions
1127  Hooks::run( 'SkinTemplateNavigation::Universal', [ &$this, &$content_navigation ] );
1128 
1129  // Setup xml ids and tooltip info
1130  foreach ( $content_navigation as $section => &$links ) {
1131  foreach ( $links as $key => &$link ) {
1132  $xmlID = $key;
1133  if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1134  $xmlID = 'ca-nstab-' . $xmlID;
1135  } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1136  $xmlID = 'ca-talk';
1137  $link['rel'] = 'discussion';
1138  } elseif ( $section == 'variants' ) {
1139  $xmlID = 'ca-varlang-' . $xmlID;
1140  } else {
1141  $xmlID = 'ca-' . $xmlID;
1142  }
1143  $link['id'] = $xmlID;
1144  }
1145  }
1146 
1147  # We don't want to give the watch tab an accesskey if the
1148  # page is being edited, because that conflicts with the
1149  # accesskey on the watch checkbox. We also don't want to
1150  # give the edit tab an accesskey, because that's fairly
1151  # superfluous and conflicts with an accesskey (Ctrl-E) often
1152  # used for editing in Safari.
1153  if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1154  if ( isset( $content_navigation['views']['edit'] ) ) {
1155  $content_navigation['views']['edit']['tooltiponly'] = true;
1156  }
1157  if ( isset( $content_navigation['actions']['watch'] ) ) {
1158  $content_navigation['actions']['watch']['tooltiponly'] = true;
1159  }
1160  if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1161  $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1162  }
1163  }
1164 
1165  return $content_navigation;
1166  }
1167 
1173  private function buildContentActionUrls( $content_navigation ) {
1174 
1175  // content_actions has been replaced with content_navigation for backwards
1176  // compatibility and also for skins that just want simple tabs content_actions
1177  // is now built by flattening the content_navigation arrays into one
1178 
1179  $content_actions = [];
1180 
1181  foreach ( $content_navigation as $links ) {
1182  foreach ( $links as $key => $value ) {
1183  if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1184  // Redundant tabs are dropped from content_actions
1185  continue;
1186  }
1187 
1188  // content_actions used to have ids built using the "ca-$key" pattern
1189  // so the xmlID based id is much closer to the actual $key that we want
1190  // for that reason we'll just strip out the ca- if present and use
1191  // the latter potion of the "id" as the $key
1192  if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1193  $key = substr( $value['id'], 3 );
1194  }
1195 
1196  if ( isset( $content_actions[$key] ) ) {
1197  wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1198  "content_navigation into content_actions.\n" );
1199  continue;
1200  }
1201 
1202  $content_actions[$key] = $value;
1203  }
1204  }
1205 
1206  return $content_actions;
1207  }
1208 
1213  protected function buildNavUrls() {
1215 
1216  $out = $this->getOutput();
1217  $request = $this->getRequest();
1218 
1219  $nav_urls = [];
1220  $nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
1221  if ( $wgUploadNavigationUrl ) {
1222  $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1223  } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1224  $nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
1225  } else {
1226  $nav_urls['upload'] = false;
1227  }
1228  $nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
1229 
1230  $nav_urls['print'] = false;
1231  $nav_urls['permalink'] = false;
1232  $nav_urls['info'] = false;
1233  $nav_urls['whatlinkshere'] = false;
1234  $nav_urls['recentchangeslinked'] = false;
1235  $nav_urls['contributions'] = false;
1236  $nav_urls['log'] = false;
1237  $nav_urls['blockip'] = false;
1238  $nav_urls['emailuser'] = false;
1239  $nav_urls['userrights'] = false;
1240 
1241  // A print stylesheet is attached to all pages, but nobody ever
1242  // figures that out. :) Add a link...
1243  if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1244  $nav_urls['print'] = [
1245  'text' => $this->msg( 'printableversion' )->text(),
1246  'href' => $this->getTitle()->getLocalURL(
1247  $request->appendQueryValue( 'printable', 'yes' ) )
1248  ];
1249  }
1250 
1251  if ( $out->isArticle() ) {
1252  // Also add a "permalink" while we're at it
1253  $revid = $this->getRevisionId();
1254  if ( $revid ) {
1255  $nav_urls['permalink'] = [
1256  'text' => $this->msg( 'permalink' )->text(),
1257  'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1258  ];
1259  }
1260 
1261  // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1262  Hooks::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1263  [ &$this, &$nav_urls, &$revid, &$revid ] );
1264  }
1265 
1266  if ( $out->isArticleRelated() ) {
1267  $nav_urls['whatlinkshere'] = [
1268  'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1269  ];
1270 
1271  $nav_urls['info'] = [
1272  'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1273  'href' => $this->getTitle()->getLocalURL( "action=info" )
1274  ];
1275 
1276  if ( $this->getTitle()->exists() ) {
1277  $nav_urls['recentchangeslinked'] = [
1278  'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1279  ];
1280  }
1281  }
1282 
1283  $user = $this->getRelevantUser();
1284  if ( $user ) {
1285  $rootUser = $user->getName();
1286 
1287  $nav_urls['contributions'] = [
1288  'text' => $this->msg( 'contributions', $rootUser )->text(),
1289  'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1290  'tooltip-params' => [ $rootUser ],
1291  ];
1292 
1293  $nav_urls['log'] = [
1294  'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1295  ];
1296 
1297  if ( $this->getUser()->isAllowed( 'block' ) ) {
1298  $nav_urls['blockip'] = [
1299  'text' => $this->msg( 'blockip', $rootUser )->text(),
1300  'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1301  ];
1302  }
1303 
1304  if ( $this->showEmailUser( $user ) ) {
1305  $nav_urls['emailuser'] = [
1306  'text' => $this->msg( 'tool-link-emailuser', $rootUser )->text(),
1307  'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1308  'tooltip-params' => [ $rootUser ],
1309  ];
1310  }
1311 
1312  if ( !$user->isAnon() ) {
1313  $sur = new UserrightsPage;
1314  $sur->setContext( $this->getContext() );
1315  if ( $sur->userCanExecute( $this->getUser() ) ) {
1316  $nav_urls['userrights'] = [
1317  'text' => $this->msg( 'tool-link-userrights', $this->getUser()->getName() )->text(),
1318  'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1319  ];
1320  }
1321  }
1322  }
1323 
1324  return $nav_urls;
1325  }
1326 
1331  protected function getNameSpaceKey() {
1332  return $this->getTitle()->getNamespaceKey();
1333  }
1334 }
setContext(IContextSource $context)
Set the IContextSource object.
$wgFooterIcons
Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can ad...
lastModified()
Get the timestamp of the latest revision, formatted in user language.
Definition: Skin.php:833
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:1936
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
logoText($align= '')
Definition: Skin.php:860
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:802
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1555
getLanguage()
Get the Language object.
$wgScript
The URL path to index.php.
afterContentHook()
This runs a hook to allow extensions placing their stuff after content and article metadata (e...
Definition: Skin.php:554
The main skin class which provides methods and properties for all other skins.
Definition: Skin.php:34
getPoweredBy()
Gets the powered by MediaWiki icon.
Definition: Skin.php:809
getNewtalks()
Gets new talk page messages for the current user and returns an appropriate alert message (or an empt...
Definition: Skin.php:1332
getLanguages()
Generates array of language links for the current page.
$wgSitename
Name of the site.
outputPage(OutputPage $out=null)
initialize various variables and generate the template
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
static isAllowed($user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Definition: UploadBase.php:131
$wgJsMimeType
Previously used as content type in HTML script tags.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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
buildSidebar()
Build an array that represents the sidebar(s), the navigation bar among them.
Definition: Skin.php:1188
$wgMimeType
The default Content-Type header.
static instance()
Singleton.
Definition: Profiler.php:61
privacyLink()
Gets the link to the wiki's privacy policy page.
Definition: Skin.php:949
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
string $template
For QuickTemplate, the name of the subclass which will actually fill the template.
initPage(OutputPage $out)
Definition: Skin.php:144
editUrlOptions()
Return URL options for the 'edit page' link.
Definition: Skin.php:976
buildContentNavigationUrls()
a structured array of links usually used for the tabs in a skin
setupSkinUserCss(OutputPage $out)
Add specific styles for this skin.
$value
const NS_SPECIAL
Definition: Defines.php:45
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
getCopyrightIcon()
Definition: Skin.php:779
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 MediaWikiServices
Definition: injection.txt:23
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
$wgArticlePath
Definition: img_auth.php:45
wfReportTime()
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
getCategories()
Definition: Skin.php:519
isSyndicated()
Should we output feed links for this page?
static getRestrictionLevels($index, User $user=null)
Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a use...
getTitle()
Get the Title object.
getSiteNotice()
Get the site notice.
Definition: Skin.php:1477
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
static factory($action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition: Action.php:95
getRequest()
Get the WebRequest object.
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:1936
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
msg()
Get a Message object with context set Parameters are the same as wfMessage()
getCopyright($type= 'detect')
Definition: Skin.php:733
getHTML()
Get the body HTML.
$wgStylePath
The URL path of the skins directory.
printOrError($str)
Output the string, or print error message if it's an error object of the appropriate type...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc & $personal_urls
Definition: hooks.txt:2491
static groupHasPermission($group, $role)
Check, if the given group has the given permission.
Definition: User.php:4625
useCombinedLoginLink()
Output a boolean indicating if buildPersonalUrls should output separate login and create account link...
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
Base class for template-based skins.
getRelevantTitle()
Return the "relevant" title.
Definition: Skin.php:267
$res
Definition: database.txt:21
getConfig()
Get the Config object.
disclaimerLink()
Gets the link to the wiki's general disclaimers page.
Definition: Skin.php:965
getContext()
Get the base IContextSource object.
$params
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
generateDebugHTML()
Generate debug data HTML for displaying at the bottom of the main content area.
Definition: Skin.php:580
wfBCP47($code)
Get the normalised IETF language tag See unit test for examples.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
showEmailUser($id)
Definition: Skin.php:990
getRelevantUser()
Return the "relevant" user.
Definition: Skin.php:291
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
Definition: Action.php:122
aboutLink()
Gets the link to the wiki's about page.
Definition: Skin.php:957
const NS_FILE
Definition: Defines.php:62
makeTalkUrlDetails($name, $urlaction= '')
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
$wgDisableLangConversion
Whether to enable language variant conversion.
Special handling for file pages.
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 modifiable & $code
Definition: hooks.txt:802
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:43
const NS_MEDIAWIKI
Definition: Defines.php:64
static fetchLanguageName($code, $inLanguage=null, $include= 'all')
Definition: Language.php:888
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:112
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:2889
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
makeArticleUrlDetails($name, $urlaction= '')
printSource()
Text with the permalink to the source page, usually shown on the footer of a printed page...
Definition: Skin.php:605
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
tabAction($title, $message, $selected, $query= '', $checkEdit=false)
Builds an array with tab definition.
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
$wgHideInterlanguageLinks
Hide interlanguage links from the sidebar.
buildPersonalUrls()
build array of urls for personal toolbar
static resolveAlias($alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
isRevisionCurrent()
Whether the revision displayed is the latest revision of the page.
Definition: Skin.php:243
$wgScriptPath
The path we should point to.
wfArrayToCgi($array1, $array2=null, $prefix= '')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
string $skinname
Name of our skin, it probably needs to be all lower case.
getNameSpaceKey()
Generate strings used for xml 'id' names.
wrapHTML($title, $html)
Wrap the body text with language information and identifiable element.
buildContentActionUrls($content_navigation)
an array of edit links by default used for the tabs
prepareQuickTemplate()
initialize various variables and generate the template
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
$wgLogo
The URL path of the wiki logo.
Special page to allow managing user group membership.
getUndeleteLink()
Definition: Skin.php:623
$wgServer
URL of the server.
subPageSubtitle($out=null)
Definition: Skin.php:652
$wgUseCombinedLoginLink
Login / create account link behavior when it's possible for anonymous users to create an account...
getRevisionId()
Get the current revision ID.
Definition: Skin.php:234
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
escapeSearchLink()
Definition: Skin.php:725
getWikiPage()
Get the WikiPage object.
static getSubject($index)
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
setupTemplate($classname, $repository=false, $cache_dir=false)
Create the template engine object; we feed it a bunch of data and eventually it spits out some HTML...
getUser()
Get the User object.
setContext($context)
Sets the context this SpecialPage is executed in.
bottomScripts()
This gets called shortly before the "" tag.
Definition: Skin.php:589
addModuleStyles($modules)
Add only CSS of one or more modules recognized by ResourceLoader.
Definition: OutputPage.php:612
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2491
formatLanguageName($name)
Format language name for use in sidebar interlanguage links list.
buildNavUrls()
build array of common navigation links
getOutput()
Get the OutputPage object.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300
getPersonalToolsList()
Get the HTML for the p-personal list.