MediaWiki  1.27.2
SkinTemplate.php
Go to the documentation of this file.
1 <?php
35 class SkinTemplate extends Skin {
40  public $skinname = 'monobook';
41 
46  public $template = 'QuickTemplate';
47 
48  public $thispage;
49  public $titletxt;
50  public $userpage;
51  public $thisquery;
52  public $loggedin;
53  public $username;
55 
62  $moduleStyles = [
63  'mediawiki.legacy.shared',
64  'mediawiki.legacy.commonPrint',
65  'mediawiki.sectionAnchor'
66  ];
67  if ( $out->isSyndicated() ) {
68  $moduleStyles[] = 'mediawiki.feedlink';
69  }
70 
71  // Deprecated since 1.26: Unconditional loading of mediawiki.ui.button
72  // on every page is deprecated. Express a dependency instead.
73  if ( strpos( $out->getHTML(), 'mw-ui-button' ) !== false ) {
74  $moduleStyles[] = 'mediawiki.ui.button';
75  }
76 
77  $out->addModuleStyles( $moduleStyles );
78  }
79 
91  function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
92  return new $classname( $this->getConfig() );
93  }
94 
100  public function getLanguages() {
102  if ( $wgHideInterlanguageLinks ) {
103  return [];
104  }
105 
106  $userLang = $this->getLanguage();
107  $languageLinks = [];
108 
109  foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
110  $class = 'interlanguage-link interwiki-' . explode( ':', $languageLinkText, 2 )[0];
111 
112  $languageLinkTitle = Title::newFromText( $languageLinkText );
113  if ( $languageLinkTitle ) {
114  $ilInterwikiCode = $languageLinkTitle->getInterwiki();
115  $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
116 
117  if ( strval( $ilLangName ) === '' ) {
118  $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
119  if ( !$ilDisplayTextMsg->isDisabled() ) {
120  // Use custom MW message for the display text
121  $ilLangName = $ilDisplayTextMsg->text();
122  } else {
123  // Last resort: fallback to the language link target
124  $ilLangName = $languageLinkText;
125  }
126  } else {
127  // Use the language autonym as display text
128  $ilLangName = $this->formatLanguageName( $ilLangName );
129  }
130 
131  // CLDR extension or similar is required to localize the language name;
132  // otherwise we'll end up with the autonym again.
133  $ilLangLocalName = Language::fetchLanguageName(
134  $ilInterwikiCode,
135  $userLang->getCode()
136  );
137 
138  $languageLinkTitleText = $languageLinkTitle->getText();
139  if ( $ilLangLocalName === '' ) {
140  $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
141  if ( !$ilFriendlySiteName->isDisabled() ) {
142  if ( $languageLinkTitleText === '' ) {
143  $ilTitle = wfMessage(
144  'interlanguage-link-title-nonlangonly',
145  $ilFriendlySiteName->text()
146  )->text();
147  } else {
148  $ilTitle = wfMessage(
149  'interlanguage-link-title-nonlang',
150  $languageLinkTitleText,
151  $ilFriendlySiteName->text()
152  )->text();
153  }
154  } else {
155  // we have nothing friendly to put in the title, so fall back to
156  // displaying the interlanguage link itself in the title text
157  // (similar to what is done in page content)
158  $ilTitle = $languageLinkTitle->getInterwiki() .
159  ":$languageLinkTitleText";
160  }
161  } elseif ( $languageLinkTitleText === '' ) {
162  $ilTitle = wfMessage(
163  'interlanguage-link-title-langonly',
164  $ilLangLocalName
165  )->text();
166  } else {
167  $ilTitle = wfMessage(
168  'interlanguage-link-title',
169  $languageLinkTitleText,
170  $ilLangLocalName
171  )->text();
172  }
173 
174  $ilInterwikiCodeBCP47 = wfBCP47( $ilInterwikiCode );
175  $languageLink = [
176  'href' => $languageLinkTitle->getFullURL(),
177  'text' => $ilLangName,
178  'title' => $ilTitle,
179  'class' => $class,
180  'lang' => $ilInterwikiCodeBCP47,
181  'hreflang' => $ilInterwikiCodeBCP47,
182  ];
183  Hooks::run(
184  'SkinTemplateGetLanguageLink',
185  [ &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() ]
186  );
187  $languageLinks[] = $languageLink;
188  }
189  }
190 
191  return $languageLinks;
192  }
193 
194  protected function setupTemplateForOutput() {
195 
196  $request = $this->getRequest();
197  $user = $this->getUser();
198  $title = $this->getTitle();
199 
200  $tpl = $this->setupTemplate( $this->template, 'skins' );
201 
202  $this->thispage = $title->getPrefixedDBkey();
203  $this->titletxt = $title->getPrefixedText();
204  $this->userpage = $user->getUserPage()->getPrefixedText();
205  $query = [];
206  if ( !$request->wasPosted() ) {
207  $query = $request->getValues();
208  unset( $query['title'] );
209  unset( $query['returnto'] );
210  unset( $query['returntoquery'] );
211  }
212  $this->thisquery = wfArrayToCgi( $query );
213  $this->loggedin = $user->isLoggedIn();
214  $this->username = $user->getName();
215 
216  if ( $this->loggedin ) {
217  $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
218  } else {
219  # This won't be used in the standard skins, but we define it to preserve the interface
220  # To save time, we check for existence
221  $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
222  }
223 
224  return $tpl;
225  }
226 
232  function outputPage( OutputPage $out = null ) {
233  Profiler::instance()->setTemplated( true );
234 
235  $oldContext = null;
236  if ( $out !== null ) {
237  // Deprecated since 1.20, note added in 1.25
238  wfDeprecated( __METHOD__, '1.25' );
239  $oldContext = $this->getContext();
240  $this->setContext( $out->getContext() );
241  }
242 
243  $out = $this->getOutput();
244 
245  $this->initPage( $out );
246  $tpl = $this->prepareQuickTemplate( $out );
247  // execute template
248  $res = $tpl->execute();
249 
250  // result may be an error
251  $this->printOrError( $res );
252 
253  if ( $oldContext ) {
254  $this->setContext( $oldContext );
255  }
256 
257  }
258 
266  protected function wrapHTML( $title, $html ) {
267  # An ID that includes the actual body text; without categories, contentSub, ...
268  $realBodyAttribs = [ 'id' => 'mw-content-text' ];
269 
270  # Add a mw-content-ltr/rtl class to be able to style based on text direction
271  # when the content is different from the UI language, i.e.:
272  # not for special pages or file pages AND only when viewing
273  if ( !in_array( $title->getNamespace(), [ NS_SPECIAL, NS_FILE ] ) &&
274  Action::getActionName( $this ) === 'view' ) {
275  $pageLang = $title->getPageViewLanguage();
276  $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
277  $realBodyAttribs['dir'] = $pageLang->getDir();
278  $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
279  }
280 
281  return Html::rawElement( 'div', $realBodyAttribs, $html );
282  }
283 
290  protected function prepareQuickTemplate() {
292  $wgSitename, $wgLogo, $wgMaxCredits,
293  $wgShowCreditsIfMax, $wgArticlePath,
295 
296  $title = $this->getTitle();
297  $request = $this->getRequest();
298  $out = $this->getOutput();
299  $tpl = $this->setupTemplateForOutput();
300 
301  $tpl->set( 'title', $out->getPageTitle() );
302  $tpl->set( 'pagetitle', $out->getHTMLTitle() );
303  $tpl->set( 'displaytitle', $out->mPageLinkTitle );
304 
305  $tpl->setRef( 'thispage', $this->thispage );
306  $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
307  $tpl->set( 'titletext', $title->getText() );
308  $tpl->set( 'articleid', $title->getArticleID() );
309 
310  $tpl->set( 'isarticle', $out->isArticle() );
311 
312  $subpagestr = $this->subPageSubtitle();
313  if ( $subpagestr !== '' ) {
314  $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
315  }
316  $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
317 
318  $undelete = $this->getUndeleteLink();
319  if ( $undelete === '' ) {
320  $tpl->set( 'undelete', '' );
321  } else {
322  $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
323  }
324 
325  $tpl->set( 'catlinks', $this->getCategories() );
326  if ( $out->isSyndicated() ) {
327  $feeds = [];
328  foreach ( $out->getSyndicationLinks() as $format => $link ) {
329  $feeds[$format] = [
330  // Messages: feed-atom, feed-rss
331  'text' => $this->msg( "feed-$format" )->text(),
332  'href' => $link
333  ];
334  }
335  $tpl->setRef( 'feeds', $feeds );
336  } else {
337  $tpl->set( 'feeds', false );
338  }
339 
340  $tpl->setRef( 'mimetype', $wgMimeType );
341  $tpl->setRef( 'jsmimetype', $wgJsMimeType );
342  $tpl->set( 'charset', 'UTF-8' );
343  $tpl->setRef( 'wgScript', $wgScript );
344  $tpl->setRef( 'skinname', $this->skinname );
345  $tpl->set( 'skinclass', get_class( $this ) );
346  $tpl->setRef( 'skin', $this );
347  $tpl->setRef( 'stylename', $this->stylename );
348  $tpl->set( 'printable', $out->isPrintable() );
349  $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
350  $tpl->setRef( 'loggedin', $this->loggedin );
351  $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
352  $tpl->set( 'searchaction', $this->escapeSearchLink() );
353  $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
354  $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
355  $tpl->setRef( 'stylepath', $wgStylePath );
356  $tpl->setRef( 'articlepath', $wgArticlePath );
357  $tpl->setRef( 'scriptpath', $wgScriptPath );
358  $tpl->setRef( 'serverurl', $wgServer );
359  $tpl->setRef( 'logopath', $wgLogo );
360  $tpl->setRef( 'sitename', $wgSitename );
361 
362  $userLang = $this->getLanguage();
363  $userLangCode = $userLang->getHtmlCode();
364  $userLangDir = $userLang->getDir();
365 
366  $tpl->set( 'lang', $userLangCode );
367  $tpl->set( 'dir', $userLangDir );
368  $tpl->set( 'rtl', $userLang->isRTL() );
369 
370  $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
371  $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
372  $tpl->set( 'username', $this->loggedin ? $this->username : null );
373  $tpl->setRef( 'userpage', $this->userpage );
374  $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
375  $tpl->set( 'userlang', $userLangCode );
376 
377  // Users can have their language set differently than the
378  // content of the wiki. For these users, tell the web browser
379  // that interface elements are in a different language.
380  $tpl->set( 'userlangattributes', '' );
381  $tpl->set( 'specialpageattributes', '' ); # obsolete
382  // Used by VectorBeta to insert HTML before content but after the
383  // heading for the page title. Defaults to empty string.
384  $tpl->set( 'prebodyhtml', '' );
385 
386  if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
387  $escUserlang = htmlspecialchars( $userLangCode );
388  $escUserdir = htmlspecialchars( $userLangDir );
389  // Attributes must be in double quotes because htmlspecialchars() doesn't
390  // escape single quotes
391  $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
392  $tpl->set( 'userlangattributes', $attrs );
393  }
394 
395  $tpl->set( 'newtalk', $this->getNewtalks() );
396  $tpl->set( 'logo', $this->logoText() );
397 
398  $tpl->set( 'copyright', false );
399  // No longer used
400  $tpl->set( 'viewcount', false );
401  $tpl->set( 'lastmod', false );
402  $tpl->set( 'credits', false );
403  $tpl->set( 'numberofwatchingusers', false );
404  if ( $out->isArticle() && $title->exists() ) {
405  if ( $this->isRevisionCurrent() ) {
406  if ( $wgMaxCredits != 0 ) {
407  $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
408  $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
409  } else {
410  $tpl->set( 'lastmod', $this->lastModified() );
411  }
412  }
413  $tpl->set( 'copyright', $this->getCopyright() );
414  }
415 
416  $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
417  $tpl->set( 'poweredbyico', $this->getPoweredBy() );
418  $tpl->set( 'disclaimer', $this->disclaimerLink() );
419  $tpl->set( 'privacy', $this->privacyLink() );
420  $tpl->set( 'about', $this->aboutLink() );
421 
422  $tpl->set( 'footerlinks', [
423  'info' => [
424  'lastmod',
425  'numberofwatchingusers',
426  'credits',
427  'copyright',
428  ],
429  'places' => [
430  'privacy',
431  'about',
432  'disclaimer',
433  ],
434  ] );
435 
437  $tpl->set( 'footericons', $wgFooterIcons );
438  foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
439  if ( count( $footerIconsBlock ) > 0 ) {
440  foreach ( $footerIconsBlock as &$footerIcon ) {
441  if ( isset( $footerIcon['src'] ) ) {
442  if ( !isset( $footerIcon['width'] ) ) {
443  $footerIcon['width'] = 88;
444  }
445  if ( !isset( $footerIcon['height'] ) ) {
446  $footerIcon['height'] = 31;
447  }
448  }
449  }
450  } else {
451  unset( $tpl->data['footericons'][$footerIconsKey] );
452  }
453  }
454 
455  $tpl->set( 'indicators', $out->getIndicators() );
456 
457  $tpl->set( 'sitenotice', $this->getSiteNotice() );
458  $tpl->set( 'bottomscripts', $this->bottomScripts() );
459  $tpl->set( 'printfooter', $this->printSource() );
460  // Wrap the bodyText with #mw-content-text element
461  $out->mBodytext = $this->wrapHTML( $title, $out->mBodytext );
462  $tpl->setRef( 'bodytext', $out->mBodytext );
463 
464  $language_urls = $this->getLanguages();
465  if ( count( $language_urls ) ) {
466  $tpl->setRef( 'language_urls', $language_urls );
467  } else {
468  $tpl->set( 'language_urls', false );
469  }
470 
471  # Personal toolbar
472  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
473  $content_navigation = $this->buildContentNavigationUrls();
474  $content_actions = $this->buildContentActionUrls( $content_navigation );
475  $tpl->setRef( 'content_navigation', $content_navigation );
476  $tpl->setRef( 'content_actions', $content_actions );
477 
478  $tpl->set( 'sidebar', $this->buildSidebar() );
479  $tpl->set( 'nav_urls', $this->buildNavUrls() );
480 
481  // Set the head scripts near the end, in case the above actions resulted in added scripts
482  $tpl->set( 'headelement', $out->headElement( $this ) );
483 
484  $tpl->set( 'debug', '' );
485  $tpl->set( 'debughtml', $this->generateDebugHTML() );
486  $tpl->set( 'reporttime', wfReportTime() );
487 
488  // original version by hansm
489  if ( !Hooks::run( 'SkinTemplateOutputPageBeforeExec', [ &$this, &$tpl ] ) ) {
490  wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
491  }
492 
493  // Set the bodytext to another key so that skins can just output it on its own
494  // and output printfooter and debughtml separately
495  $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
496 
497  // Append printfooter and debughtml onto bodytext so that skins that
498  // were already using bodytext before they were split out don't suddenly
499  // start not outputting information.
500  $tpl->data['bodytext'] .= Html::rawElement(
501  'div',
502  [ 'class' => 'printfooter' ],
503  "\n{$tpl->data['printfooter']}"
504  ) . "\n";
505  $tpl->data['bodytext'] .= $tpl->data['debughtml'];
506 
507  // allow extensions adding stuff after the page content.
508  // See Skin::afterContentHook() for further documentation.
509  $tpl->set( 'dataAfterContent', $this->afterContentHook() );
510 
511  return $tpl;
512  }
513 
518  public function getPersonalToolsList() {
519  $tpl = $this->setupTemplateForOutput();
520  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
521  $html = '';
522  foreach ( $tpl->getPersonalTools() as $key => $item ) {
523  $html .= $tpl->makeListItem( $key, $item );
524  }
525  return $html;
526  }
527 
536  function formatLanguageName( $name ) {
537  return $this->getLanguage()->ucfirst( $name );
538  }
539 
548  function printOrError( $str ) {
549  echo $str;
550  }
551 
561  function useCombinedLoginLink() {
564  }
565 
570  protected function buildPersonalUrls() {
571  $title = $this->getTitle();
572  $request = $this->getRequest();
573  $pageurl = $title->getLocalURL();
574 
575  /* set up the default links for the personal toolbar */
576  $personal_urls = [];
577 
578  # Due to bug 32276, if a user does not have read permissions,
579  # $this->getTitle() will just give Special:Badtitle, which is
580  # not especially useful as a returnto parameter. Use the title
581  # from the request instead, if there was one.
582  if ( $this->getUser()->isAllowed( 'read' ) ) {
583  $page = $this->getTitle();
584  } else {
585  $page = Title::newFromText( $request->getVal( 'title', '' ) );
586  }
587  $page = $request->getVal( 'returnto', $page );
588  $a = [];
589  if ( strval( $page ) !== '' ) {
590  $a['returnto'] = $page;
591  $query = $request->getVal( 'returntoquery', $this->thisquery );
592  if ( $query != '' ) {
593  $a['returntoquery'] = $query;
594  }
595  }
596 
597  $returnto = wfArrayToCgi( $a );
598  if ( $this->loggedin ) {
599  $personal_urls['userpage'] = [
600  'text' => $this->username,
601  'href' => &$this->userpageUrlDetails['href'],
602  'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
603  'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
604  'dir' => 'auto'
605  ];
606  $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
607  $personal_urls['mytalk'] = [
608  'text' => $this->msg( 'mytalk' )->text(),
609  'href' => &$usertalkUrlDetails['href'],
610  'class' => $usertalkUrlDetails['exists'] ? false : 'new',
611  'active' => ( $usertalkUrlDetails['href'] == $pageurl )
612  ];
613  $href = self::makeSpecialUrl( 'Preferences' );
614  $personal_urls['preferences'] = [
615  'text' => $this->msg( 'mypreferences' )->text(),
616  'href' => $href,
617  'active' => ( $href == $pageurl )
618  ];
619 
620  if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
621  $href = self::makeSpecialUrl( 'Watchlist' );
622  $personal_urls['watchlist'] = [
623  'text' => $this->msg( 'mywatchlist' )->text(),
624  'href' => $href,
625  'active' => ( $href == $pageurl )
626  ];
627  }
628 
629  # We need to do an explicit check for Special:Contributions, as we
630  # have to match both the title, and the target, which could come
631  # from request values (Special:Contributions?target=Jimbo_Wales)
632  # or be specified in "sub page" form
633  # (Special:Contributions/Jimbo_Wales). The plot
634  # thickens, because the Title object is altered for special pages,
635  # so it doesn't contain the original alias-with-subpage.
636  $origTitle = Title::newFromText( $request->getText( 'title' ) );
637  if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
638  list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
639  $active = $spName == 'Contributions'
640  && ( ( $spPar && $spPar == $this->username )
641  || $request->getText( 'target' ) == $this->username );
642  } else {
643  $active = false;
644  }
645 
646  $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
647  $personal_urls['mycontris'] = [
648  'text' => $this->msg( 'mycontris' )->text(),
649  'href' => $href,
650  'active' => $active
651  ];
652  $personal_urls['logout'] = [
653  'text' => $this->msg( 'pt-userlogout' )->text(),
654  'href' => self::makeSpecialUrl( 'Userlogout',
655  // userlogout link must always contain an & character, otherwise we might not be able
656  // to detect a buggy precaching proxy (bug 17790)
657  $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
658  ),
659  'active' => false
660  ];
661  } else {
662  $useCombinedLoginLink = $this->useCombinedLoginLink();
663  $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
664  ? 'nav-login-createaccount'
665  : 'pt-login';
666 
667  $login_url = [
668  'text' => $this->msg( $loginlink )->text(),
669  'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
670  'active' => $title->isSpecial( 'Userlogin' )
671  || $title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink,
672  ];
673  $createaccount_url = [
674  'text' => $this->msg( 'pt-createaccount' )->text(),
675  'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ),
676  'active' => $title->isSpecial( 'CreateAccount' ),
677  ];
678 
679  // No need to show Talk and Contributions to anons if they can't contribute!
680  if ( User::groupHasPermission( '*', 'edit' ) ) {
681  // Because of caching, we can't link directly to the IP talk and
682  // contributions pages. Instead we use the special page shortcuts
683  // (which work correctly regardless of caching). This means we can't
684  // determine whether these links are active or not, but since major
685  // skins (MonoBook, Vector) don't use this information, it's not a
686  // huge loss.
687  $personal_urls['anontalk'] = [
688  'text' => $this->msg( 'anontalk' )->text(),
689  'href' => self::makeSpecialUrlSubpage( 'Mytalk', false ),
690  'active' => false
691  ];
692  $personal_urls['anoncontribs'] = [
693  'text' => $this->msg( 'anoncontribs' )->text(),
694  'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ),
695  'active' => false
696  ];
697  }
698 
699  if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
700  $personal_urls['createaccount'] = $createaccount_url;
701  }
702 
703  $personal_urls['login'] = $login_url;
704  }
705 
706  Hooks::run( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
707  return $personal_urls;
708  }
709 
721  function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
722  $classes = [];
723  if ( $selected ) {
724  $classes[] = 'selected';
725  }
726  if ( $checkEdit && !$title->isKnown() ) {
727  $classes[] = 'new';
728  if ( $query !== '' ) {
729  $query = 'action=edit&redlink=1&' . $query;
730  } else {
731  $query = 'action=edit&redlink=1';
732  }
733  }
734 
735  // wfMessageFallback will nicely accept $message as an array of fallbacks
736  // or just a single key
737  $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
738  if ( is_array( $message ) ) {
739  // for hook compatibility just keep the last message name
740  $message = end( $message );
741  }
742  if ( $msg->exists() ) {
743  $text = $msg->text();
744  } else {
746  $text = $wgContLang->getConverter()->convertNamespace(
747  MWNamespace::getSubject( $title->getNamespace() ) );
748  }
749 
750  $result = [];
751  if ( !Hooks::run( 'SkinTemplateTabAction', [ &$this,
752  $title, $message, $selected, $checkEdit,
753  &$classes, &$query, &$text, &$result ] ) ) {
754  return $result;
755  }
756 
757  return [
758  'class' => implode( ' ', $classes ),
759  'text' => $text,
760  'href' => $title->getLocalURL( $query ),
761  'primary' => true ];
762  }
763 
764  function makeTalkUrlDetails( $name, $urlaction = '' ) {
766  if ( !is_object( $title ) ) {
767  throw new MWException( __METHOD__ . " given invalid pagename $name" );
768  }
769  $title = $title->getTalkPage();
770  self::checkTitle( $title, $name );
771  return [
772  'href' => $title->getLocalURL( $urlaction ),
773  'exists' => $title->isKnown(),
774  ];
775  }
776 
780  function makeArticleUrlDetails( $name, $urlaction = '' ) {
782  $title = $title->getSubjectPage();
783  self::checkTitle( $title, $name );
784  return [
785  'href' => $title->getLocalURL( $urlaction ),
786  'exists' => $title->exists(),
787  ];
788  }
789 
824  protected function buildContentNavigationUrls() {
826 
827  // Display tabs for the relevant title rather than always the title itself
828  $title = $this->getRelevantTitle();
829  $onPage = $title->equals( $this->getTitle() );
830 
831  $out = $this->getOutput();
832  $request = $this->getRequest();
833  $user = $this->getUser();
834 
835  $content_navigation = [
836  'namespaces' => [],
837  'views' => [],
838  'actions' => [],
839  'variants' => []
840  ];
841 
842  // parameters
843  $action = $request->getVal( 'action', 'view' );
844 
845  $userCanRead = $title->quickUserCan( 'read', $user );
846 
847  $preventActiveTabs = false;
848  Hooks::run( 'SkinTemplatePreventOtherActiveTabs', [ &$this, &$preventActiveTabs ] );
849 
850  // Checks if page is some kind of content
851  if ( $title->canExist() ) {
852  // Gets page objects for the related namespaces
853  $subjectPage = $title->getSubjectPage();
854  $talkPage = $title->getTalkPage();
855 
856  // Determines if this is a talk page
857  $isTalk = $title->isTalkPage();
858 
859  // Generates XML IDs from namespace names
860  $subjectId = $title->getNamespaceKey( '' );
861 
862  if ( $subjectId == 'main' ) {
863  $talkId = 'talk';
864  } else {
865  $talkId = "{$subjectId}_talk";
866  }
867 
868  $skname = $this->skinname;
869 
870  // Adds namespace links
871  $subjectMsg = [ "nstab-$subjectId" ];
872  if ( $subjectPage->isMainPage() ) {
873  array_unshift( $subjectMsg, 'mainpage-nstab' );
874  }
875  $content_navigation['namespaces'][$subjectId] = $this->tabAction(
876  $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
877  );
878  $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
879  $content_navigation['namespaces'][$talkId] = $this->tabAction(
880  $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
881  );
882  $content_navigation['namespaces'][$talkId]['context'] = 'talk';
883 
884  if ( $userCanRead ) {
885  $isForeignFile = $title->inNamespace( NS_FILE ) && $this->canUseWikiPage() &&
886  $this->getWikiPage() instanceof WikiFilePage && !$this->getWikiPage()->isLocal();
887 
888  // Adds view view link
889  if ( $title->exists() || $isForeignFile ) {
890  $content_navigation['views']['view'] = $this->tabAction(
891  $isTalk ? $talkPage : $subjectPage,
892  [ "$skname-view-view", 'view' ],
893  ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
894  );
895  // signal to hide this from simple content_actions
896  $content_navigation['views']['view']['redundant'] = true;
897  }
898 
899  // If it is a non-local file, show a link to the file in its own repository
900  if ( $isForeignFile ) {
901  $file = $this->getWikiPage()->getFile();
902  $content_navigation['views']['view-foreign'] = [
903  'class' => '',
904  'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
905  setContext( $this->getContext() )->
906  params( $file->getRepo()->getDisplayName() )->text(),
907  'href' => $file->getDescriptionUrl(),
908  'primary' => false,
909  ];
910  }
911 
912  // Checks if user can edit the current page if it exists or create it otherwise
913  if ( $title->quickUserCan( 'edit', $user )
914  && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
915  ) {
916  // Builds CSS class for talk page links
917  $isTalkClass = $isTalk ? ' istalk' : '';
918  // Whether the user is editing the page
919  $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
920  // Whether to show the "Add a new section" tab
921  // Checks if this is a current rev of talk page and is not forced to be hidden
922  $showNewSection = !$out->forceHideNewSectionLink()
923  && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
924  $section = $request->getVal( 'section' );
925 
926  if ( $title->exists()
927  || ( $title->getNamespace() == NS_MEDIAWIKI
928  && $title->getDefaultMessageText() !== false
929  )
930  ) {
931  $msgKey = $isForeignFile ? 'edit-local' : 'edit';
932  } else {
933  $msgKey = $isForeignFile ? 'create-local' : 'create';
934  }
935  $content_navigation['views']['edit'] = [
936  'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
937  ? 'selected'
938  : ''
939  ) . $isTalkClass,
940  'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
941  ->setContext( $this->getContext() )->text(),
942  'href' => $title->getLocalURL( $this->editUrlOptions() ),
943  'primary' => !$isForeignFile, // don't collapse this in vector
944  ];
945 
946  // section link
947  if ( $showNewSection ) {
948  // Adds new section link
949  // $content_navigation['actions']['addsection']
950  $content_navigation['views']['addsection'] = [
951  'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
952  'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
953  ->setContext( $this->getContext() )->text(),
954  'href' => $title->getLocalURL( 'action=edit&section=new' )
955  ];
956  }
957  // Checks if the page has some kind of viewable content
958  } elseif ( $title->hasSourceText() ) {
959  // Adds view source view link
960  $content_navigation['views']['viewsource'] = [
961  'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
962  'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
963  ->setContext( $this->getContext() )->text(),
964  'href' => $title->getLocalURL( $this->editUrlOptions() ),
965  'primary' => true, // don't collapse this in vector
966  ];
967  }
968 
969  // Checks if the page exists
970  if ( $title->exists() ) {
971  // Adds history view link
972  $content_navigation['views']['history'] = [
973  'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
974  'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
975  ->setContext( $this->getContext() )->text(),
976  'href' => $title->getLocalURL( 'action=history' ),
977  ];
978 
979  if ( $title->quickUserCan( 'delete', $user ) ) {
980  $content_navigation['actions']['delete'] = [
981  'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
982  'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
983  ->setContext( $this->getContext() )->text(),
984  'href' => $title->getLocalURL( 'action=delete' )
985  ];
986  }
987 
988  if ( $title->quickUserCan( 'move', $user ) ) {
989  $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
990  $content_navigation['actions']['move'] = [
991  'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
992  'text' => wfMessageFallback( "$skname-action-move", 'move' )
993  ->setContext( $this->getContext() )->text(),
994  'href' => $moveTitle->getLocalURL()
995  ];
996  }
997  } else {
998  // article doesn't exist or is deleted
999  if ( $user->isAllowed( 'deletedhistory' ) ) {
1000  $n = $title->isDeleted();
1001  if ( $n ) {
1002  $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1003  // If the user can't undelete but can view deleted
1004  // history show them a "View .. deleted" tab instead.
1005  $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1006  $content_navigation['actions']['undelete'] = [
1007  'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1008  'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1009  ->setContext( $this->getContext() )->numParams( $n )->text(),
1010  'href' => $undelTitle->getLocalURL()
1011  ];
1012  }
1013  }
1014  }
1015 
1016  if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1017  MWNamespace::getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1018  ) {
1019  $mode = $title->isProtected() ? 'unprotect' : 'protect';
1020  $content_navigation['actions'][$mode] = [
1021  'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1022  'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1023  ->setContext( $this->getContext() )->text(),
1024  'href' => $title->getLocalURL( "action=$mode" )
1025  ];
1026  }
1027 
1028  // Checks if the user is logged in
1029  if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1039  $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1040  $content_navigation['actions'][$mode] = [
1041  'class' => 'mw-watchlink ' . (
1042  $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : ''
1043  ),
1044  // uses 'watch' or 'unwatch' message
1045  'text' => $this->msg( $mode )->text(),
1046  'href' => $title->getLocalURL( [ 'action' => $mode ] )
1047  ];
1048  }
1049  }
1050 
1051  Hooks::run( 'SkinTemplateNavigation', [ &$this, &$content_navigation ] );
1052 
1053  if ( $userCanRead && !$wgDisableLangConversion ) {
1054  $pageLang = $title->getPageLanguage();
1055  // Gets list of language variants
1056  $variants = $pageLang->getVariants();
1057  // Checks that language conversion is enabled and variants exist
1058  // And if it is not in the special namespace
1059  if ( count( $variants ) > 1 ) {
1060  // Gets preferred variant (note that user preference is
1061  // only possible for wiki content language variant)
1062  $preferred = $pageLang->getPreferredVariant();
1063  if ( Action::getActionName( $this ) === 'view' ) {
1064  $params = $request->getQueryValues();
1065  unset( $params['title'] );
1066  } else {
1067  $params = [];
1068  }
1069  // Loops over each variant
1070  foreach ( $variants as $code ) {
1071  // Gets variant name from language code
1072  $varname = $pageLang->getVariantname( $code );
1073  // Appends variant link
1074  $content_navigation['variants'][] = [
1075  'class' => ( $code == $preferred ) ? 'selected' : false,
1076  'text' => $varname,
1077  'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ),
1078  'lang' => wfBCP47( $code ),
1079  'hreflang' => wfBCP47( $code ),
1080  ];
1081  }
1082  }
1083  }
1084  } else {
1085  // If it's not content, it's got to be a special page
1086  $content_navigation['namespaces']['special'] = [
1087  'class' => 'selected',
1088  'text' => $this->msg( 'nstab-special' )->text(),
1089  'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1090  'context' => 'subject'
1091  ];
1092 
1093  Hooks::run( 'SkinTemplateNavigation::SpecialPage',
1094  [ &$this, &$content_navigation ] );
1095  }
1096 
1097  // Equiv to SkinTemplateContentActions
1098  Hooks::run( 'SkinTemplateNavigation::Universal', [ &$this, &$content_navigation ] );
1099 
1100  // Setup xml ids and tooltip info
1101  foreach ( $content_navigation as $section => &$links ) {
1102  foreach ( $links as $key => &$link ) {
1103  $xmlID = $key;
1104  if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1105  $xmlID = 'ca-nstab-' . $xmlID;
1106  } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1107  $xmlID = 'ca-talk';
1108  $link['rel'] = 'discussion';
1109  } elseif ( $section == 'variants' ) {
1110  $xmlID = 'ca-varlang-' . $xmlID;
1111  } else {
1112  $xmlID = 'ca-' . $xmlID;
1113  }
1114  $link['id'] = $xmlID;
1115  }
1116  }
1117 
1118  # We don't want to give the watch tab an accesskey if the
1119  # page is being edited, because that conflicts with the
1120  # accesskey on the watch checkbox. We also don't want to
1121  # give the edit tab an accesskey, because that's fairly
1122  # superfluous and conflicts with an accesskey (Ctrl-E) often
1123  # used for editing in Safari.
1124  if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1125  if ( isset( $content_navigation['views']['edit'] ) ) {
1126  $content_navigation['views']['edit']['tooltiponly'] = true;
1127  }
1128  if ( isset( $content_navigation['actions']['watch'] ) ) {
1129  $content_navigation['actions']['watch']['tooltiponly'] = true;
1130  }
1131  if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1132  $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1133  }
1134  }
1135 
1136  return $content_navigation;
1137  }
1138 
1144  private function buildContentActionUrls( $content_navigation ) {
1145 
1146  // content_actions has been replaced with content_navigation for backwards
1147  // compatibility and also for skins that just want simple tabs content_actions
1148  // is now built by flattening the content_navigation arrays into one
1149 
1150  $content_actions = [];
1151 
1152  foreach ( $content_navigation as $links ) {
1153  foreach ( $links as $key => $value ) {
1154  if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1155  // Redundant tabs are dropped from content_actions
1156  continue;
1157  }
1158 
1159  // content_actions used to have ids built using the "ca-$key" pattern
1160  // so the xmlID based id is much closer to the actual $key that we want
1161  // for that reason we'll just strip out the ca- if present and use
1162  // the latter potion of the "id" as the $key
1163  if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1164  $key = substr( $value['id'], 3 );
1165  }
1166 
1167  if ( isset( $content_actions[$key] ) ) {
1168  wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1169  "content_navigation into content_actions.\n" );
1170  continue;
1171  }
1172 
1173  $content_actions[$key] = $value;
1174  }
1175  }
1176 
1177  return $content_actions;
1178  }
1179 
1184  protected function buildNavUrls() {
1186 
1187  $out = $this->getOutput();
1188  $request = $this->getRequest();
1189 
1190  $nav_urls = [];
1191  $nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
1192  if ( $wgUploadNavigationUrl ) {
1193  $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1194  } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1195  $nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
1196  } else {
1197  $nav_urls['upload'] = false;
1198  }
1199  $nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
1200 
1201  $nav_urls['print'] = false;
1202  $nav_urls['permalink'] = false;
1203  $nav_urls['info'] = false;
1204  $nav_urls['whatlinkshere'] = false;
1205  $nav_urls['recentchangeslinked'] = false;
1206  $nav_urls['contributions'] = false;
1207  $nav_urls['log'] = false;
1208  $nav_urls['blockip'] = false;
1209  $nav_urls['emailuser'] = false;
1210  $nav_urls['userrights'] = false;
1211 
1212  // A print stylesheet is attached to all pages, but nobody ever
1213  // figures that out. :) Add a link...
1214  if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1215  $nav_urls['print'] = [
1216  'text' => $this->msg( 'printableversion' )->text(),
1217  'href' => $this->getTitle()->getLocalURL(
1218  $request->appendQueryValue( 'printable', 'yes' ) )
1219  ];
1220  }
1221 
1222  if ( $out->isArticle() ) {
1223  // Also add a "permalink" while we're at it
1224  $revid = $this->getRevisionId();
1225  if ( $revid ) {
1226  $nav_urls['permalink'] = [
1227  'text' => $this->msg( 'permalink' )->text(),
1228  'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1229  ];
1230  }
1231 
1232  // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1233  Hooks::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1234  [ &$this, &$nav_urls, &$revid, &$revid ] );
1235  }
1236 
1237  if ( $out->isArticleRelated() ) {
1238  $nav_urls['whatlinkshere'] = [
1239  'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1240  ];
1241 
1242  $nav_urls['info'] = [
1243  'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1244  'href' => $this->getTitle()->getLocalURL( "action=info" )
1245  ];
1246 
1247  if ( $this->getTitle()->exists() ) {
1248  $nav_urls['recentchangeslinked'] = [
1249  'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1250  ];
1251  }
1252  }
1253 
1254  $user = $this->getRelevantUser();
1255  if ( $user ) {
1256  $rootUser = $user->getName();
1257 
1258  $nav_urls['contributions'] = [
1259  'text' => $this->msg( 'contributions', $rootUser )->text(),
1260  'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1261  'tooltip-params' => [ $rootUser ],
1262  ];
1263 
1264  $nav_urls['log'] = [
1265  'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1266  ];
1267 
1268  if ( $this->getUser()->isAllowed( 'block' ) ) {
1269  $nav_urls['blockip'] = [
1270  'text' => $this->msg( 'blockip', $rootUser )->text(),
1271  'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1272  ];
1273  }
1274 
1275  if ( $this->showEmailUser( $user ) ) {
1276  $nav_urls['emailuser'] = [
1277  'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1278  'tooltip-params' => [ $rootUser ],
1279  ];
1280  }
1281 
1282  if ( !$user->isAnon() ) {
1283  $sur = new UserrightsPage;
1284  $sur->setContext( $this->getContext() );
1285  if ( $sur->userCanExecute( $this->getUser() ) ) {
1286  $nav_urls['userrights'] = [
1287  'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1288  ];
1289  }
1290  }
1291  }
1292 
1293  return $nav_urls;
1294  }
1295 
1300  protected function getNameSpaceKey() {
1301  return $this->getTitle()->getNamespaceKey();
1302  }
1303 }
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:832
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:1798
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:859
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:762
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:1418
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:557
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
The main skin class which provides methods and properties for all other skins.
Definition: Skin.php:34
subPageSubtitle()
Definition: Skin.php:654
getPoweredBy()
Gets the powered by MediaWiki icon.
Definition: Skin.php:808
getNewtalks()
Gets new talk page messages for the current user and returns an appropriate alert message (or an empt...
Definition: Skin.php:1329
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
static isAllowed($user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Definition: UploadBase.php:122
$wgJsMimeType
Previously used as content type in HTML script tags.
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name.
Definition: SpecialPage.php:75
buildSidebar()
Build an array that represents the sidebar(s), the navigation bar among them.
Definition: Skin.php:1187
$wgMimeType
The default Content-Type header.
static instance()
Singleton.
Definition: Profiler.php:60
privacyLink()
Gets the link to the wiki's privacy policy page.
Definition: Skin.php:948
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:210
string $template
For QuickTemplate, the name of the subclass which will actually fill the template.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
initPage(OutputPage $out)
Definition: Skin.php:144
editUrlOptions()
Return URL options for the 'edit page' link.
Definition: Skin.php:975
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:58
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
getCopyrightIcon()
Definition: Skin.php:778
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:277
Represents a title within MediaWiki.
Definition: Title.php:34
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:522
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:1474
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':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:1796
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
Definition: hooks.txt:2581
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:1798
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:732
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:2338
static groupHasPermission($group, $role)
Check, if the given group has the given permission.
Definition: User.php:4552
useCombinedLoginLink()
Output a boolean indicating if buildPersonalUrls should output separate login and create account link...
Base class for template-based skins.
getRelevantTitle()
Return the "relevant" title.
Definition: Skin.php:270
$res
Definition: database.txt:21
getConfig()
Get the Config object.
disclaimerLink()
Gets the link to the wiki's general disclaimers page.
Definition: Skin.php:964
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing 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
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:583
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:912
showEmailUser($id)
Definition: Skin.php:989
getRelevantUser()
Return the "relevant" user.
Definition: Skin.php:294
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:956
const NS_FILE
Definition: Defines.php:75
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:762
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:42
const NS_MEDIAWIKI
Definition: Defines.php:77
static fetchLanguageName($code, $inLanguage=null, $include= 'all')
Definition: Language.php:886
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:103
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:2715
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
isSpecialPage()
Returns true if this is a special page.
Definition: Title.php:1045
makeArticleUrlDetails($name, $urlaction= '')
printSource()
Text with the permalink to the source page, usually shown on the footer of a printed page...
Definition: Skin.php:608
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:2418
$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:246
$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:626
$wgServer
URL of the server.
$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:237
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
escapeSearchLink()
Definition: Skin.php:724
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:592
addModuleStyles($modules)
Add only CSS of one or more modules recognized by ResourceLoader.
Definition: OutputPage.php:618
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:2338
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:310
getPersonalToolsList()
Get the HTML for the p-personal list.