MediaWiki REL1_29
SkinTemplate.php
Go to the documentation of this file.
1<?php
23
38class 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
64 public function setupSkinUserCss( OutputPage $out ) {
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() {
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 $request = $this->getRequest();
200 $user = $this->getUser();
201 $title = $this->getTitle();
202
203 $tpl = $this->setupTemplate( $this->template, 'skins' );
204
205 $this->thispage = $title->getPrefixedDBkey();
206 $this->titletxt = $title->getPrefixedText();
207 $this->userpage = $user->getUserPage()->getPrefixedText();
208 $query = [];
209 if ( !$request->wasPosted() ) {
210 $query = $request->getValues();
211 unset( $query['title'] );
212 unset( $query['returnto'] );
213 unset( $query['returntoquery'] );
214 }
215 $this->thisquery = wfArrayToCgi( $query );
216 $this->loggedin = $user->isLoggedIn();
217 $this->username = $user->getName();
218
219 if ( $this->loggedin ) {
220 $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
221 } else {
222 # This won't be used in the standard skins, but we define it to preserve the interface
223 # To save time, we check for existence
224 $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
225 }
226
227 return $tpl;
228 }
229
235 function outputPage( OutputPage $out = null ) {
236 Profiler::instance()->setTemplated( true );
237
238 $oldContext = null;
239 if ( $out !== null ) {
240 // Deprecated since 1.20, note added in 1.25
241 wfDeprecated( __METHOD__, '1.25' );
242 $oldContext = $this->getContext();
243 $this->setContext( $out->getContext() );
244 }
245
246 $out = $this->getOutput();
247
248 $this->initPage( $out );
249 $tpl = $this->prepareQuickTemplate();
250 // execute template
251 $res = $tpl->execute();
252
253 // result may be an error
254 $this->printOrError( $res );
255
256 if ( $oldContext ) {
257 $this->setContext( $oldContext );
258 }
259 }
260
268 protected function wrapHTML( $title, $html ) {
269 # An ID that includes the actual body text; without categories, contentSub, ...
270 $realBodyAttribs = [ 'id' => 'mw-content-text' ];
271
272 # Add a mw-content-ltr/rtl class to be able to style based on text direction
273 # when the content is different from the UI language, i.e.:
274 # not for special pages or file pages AND only when viewing
275 if ( !in_array( $title->getNamespace(), [ NS_SPECIAL, NS_FILE ] ) &&
276 Action::getActionName( $this ) === 'view' ) {
277 $pageLang = $title->getPageViewLanguage();
278 $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
279 $realBodyAttribs['dir'] = $pageLang->getDir();
280 $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
281 }
282
283 return Html::rawElement( 'div', $realBodyAttribs, $html );
284 }
285
292 protected function prepareQuickTemplate() {
297
298 $title = $this->getTitle();
299 $request = $this->getRequest();
300 $out = $this->getOutput();
301 $tpl = $this->setupTemplateForOutput();
302
303 $tpl->set( 'title', $out->getPageTitle() );
304 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
305 $tpl->set( 'displaytitle', $out->mPageLinkTitle );
306
307 $tpl->setRef( 'thispage', $this->thispage );
308 $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
309 $tpl->set( 'titletext', $title->getText() );
310 $tpl->set( 'articleid', $title->getArticleID() );
311
312 $tpl->set( 'isarticle', $out->isArticle() );
313
314 $subpagestr = $this->subPageSubtitle();
315 if ( $subpagestr !== '' ) {
316 $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
317 }
318 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
319
320 $undelete = $this->getUndeleteLink();
321 if ( $undelete === '' ) {
322 $tpl->set( 'undelete', '' );
323 } else {
324 $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
325 }
326
327 $tpl->set( 'catlinks', $this->getCategories() );
328 if ( $out->isSyndicated() ) {
329 $feeds = [];
330 foreach ( $out->getSyndicationLinks() as $format => $link ) {
331 $feeds[$format] = [
332 // Messages: feed-atom, feed-rss
333 'text' => $this->msg( "feed-$format" )->text(),
334 'href' => $link
335 ];
336 }
337 $tpl->setRef( 'feeds', $feeds );
338 } else {
339 $tpl->set( 'feeds', false );
340 }
341
342 $tpl->setRef( 'mimetype', $wgMimeType );
343 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
344 $tpl->set( 'charset', 'UTF-8' );
345 $tpl->setRef( 'wgScript', $wgScript );
346 $tpl->setRef( 'skinname', $this->skinname );
347 $tpl->set( 'skinclass', static::class );
348 $tpl->setRef( 'skin', $this );
349 $tpl->setRef( 'stylename', $this->stylename );
350 $tpl->set( 'printable', $out->isPrintable() );
351 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
352 $tpl->setRef( 'loggedin', $this->loggedin );
353 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
354 $tpl->set( 'searchaction', $this->escapeSearchLink() );
355 $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
356 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
357 $tpl->setRef( 'stylepath', $wgStylePath );
358 $tpl->setRef( 'articlepath', $wgArticlePath );
359 $tpl->setRef( 'scriptpath', $wgScriptPath );
360 $tpl->setRef( 'serverurl', $wgServer );
361 $tpl->setRef( 'logopath', $wgLogo );
362 $tpl->setRef( 'sitename', $wgSitename );
363
364 $userLang = $this->getLanguage();
365 $userLangCode = $userLang->getHtmlCode();
366 $userLangDir = $userLang->getDir();
367
368 $tpl->set( 'lang', $userLangCode );
369 $tpl->set( 'dir', $userLangDir );
370 $tpl->set( 'rtl', $userLang->isRTL() );
371
372 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
373 $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
374 $tpl->set( 'username', $this->loggedin ? $this->username : null );
375 $tpl->setRef( 'userpage', $this->userpage );
376 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
377 $tpl->set( 'userlang', $userLangCode );
378
379 // Users can have their language set differently than the
380 // content of the wiki. For these users, tell the web browser
381 // that interface elements are in a different language.
382 $tpl->set( 'userlangattributes', '' );
383 $tpl->set( 'specialpageattributes', '' ); # obsolete
384 // Used by VectorBeta to insert HTML before content but after the
385 // heading for the page title. Defaults to empty string.
386 $tpl->set( 'prebodyhtml', '' );
387
388 if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
389 $escUserlang = htmlspecialchars( $userLangCode );
390 $escUserdir = htmlspecialchars( $userLangDir );
391 // Attributes must be in double quotes because htmlspecialchars() doesn't
392 // escape single quotes
393 $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
394 $tpl->set( 'userlangattributes', $attrs );
395 }
396
397 $tpl->set( 'newtalk', $this->getNewtalks() );
398 $tpl->set( 'logo', $this->logoText() );
399
400 $tpl->set( 'copyright', false );
401 // No longer used
402 $tpl->set( 'viewcount', false );
403 $tpl->set( 'lastmod', false );
404 $tpl->set( 'credits', false );
405 $tpl->set( 'numberofwatchingusers', false );
406 if ( $out->isArticle() && $title->exists() ) {
407 if ( $this->isRevisionCurrent() ) {
408 if ( $wgMaxCredits != 0 ) {
409 $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
410 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
411 } else {
412 $tpl->set( 'lastmod', $this->lastModified() );
413 }
414 }
415 $tpl->set( 'copyright', $this->getCopyright() );
416 }
417
418 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
419 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
420 $tpl->set( 'disclaimer', $this->disclaimerLink() );
421 $tpl->set( 'privacy', $this->privacyLink() );
422 $tpl->set( 'about', $this->aboutLink() );
423
424 $tpl->set( 'footerlinks', [
425 'info' => [
426 'lastmod',
427 'numberofwatchingusers',
428 'credits',
429 'copyright',
430 ],
431 'places' => [
432 'privacy',
433 'about',
434 'disclaimer',
435 ],
436 ] );
437
439 $tpl->set( 'footericons', $wgFooterIcons );
440 foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
441 if ( count( $footerIconsBlock ) > 0 ) {
442 foreach ( $footerIconsBlock as &$footerIcon ) {
443 if ( isset( $footerIcon['src'] ) ) {
444 if ( !isset( $footerIcon['width'] ) ) {
445 $footerIcon['width'] = 88;
446 }
447 if ( !isset( $footerIcon['height'] ) ) {
448 $footerIcon['height'] = 31;
449 }
450 }
451 }
452 } else {
453 unset( $tpl->data['footericons'][$footerIconsKey] );
454 }
455 }
456
457 $tpl->set( 'indicators', $out->getIndicators() );
458
459 $tpl->set( 'sitenotice', $this->getSiteNotice() );
460 $tpl->set( 'printfooter', $this->printSource() );
461 // Wrap the bodyText with #mw-content-text element
462 $out->mBodytext = $this->wrapHTML( $title, $out->mBodytext );
463 $tpl->setRef( 'bodytext', $out->mBodytext );
464
465 $language_urls = $this->getLanguages();
466 if ( count( $language_urls ) ) {
467 $tpl->setRef( 'language_urls', $language_urls );
468 } else {
469 $tpl->set( 'language_urls', false );
470 }
471
472 # Personal toolbar
473 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
474 $content_navigation = $this->buildContentNavigationUrls();
475 $content_actions = $this->buildContentActionUrls( $content_navigation );
476 $tpl->setRef( 'content_navigation', $content_navigation );
477 $tpl->setRef( 'content_actions', $content_actions );
478
479 $tpl->set( 'sidebar', $this->buildSidebar() );
480 $tpl->set( 'nav_urls', $this->buildNavUrls() );
481
482 // Do this last in case hooks above add bottom scripts
483 $tpl->set( 'bottomscripts', $this->bottomScripts() );
484
485 // Set the head scripts near the end, in case the above actions resulted in added scripts
486 $tpl->set( 'headelement', $out->headElement( $this ) );
487
488 $tpl->set( 'debug', '' );
489 $tpl->set( 'debughtml', $this->generateDebugHTML() );
490 $tpl->set( 'reporttime', wfReportTime() );
491
492 // Avoid PHP 7.1 warning of passing $this by reference
493 $skinTemplate = $this;
494 // original version by hansm
495 if ( !Hooks::run( 'SkinTemplateOutputPageBeforeExec', [ &$skinTemplate, &$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
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 T34276, 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 (T19790)
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 $key = User::groupHasPermission( '*', 'read' )
724 ? 'login'
725 : 'login-private';
726 $personal_urls[$key] = $login_url;
727 }
728 }
729
730 Hooks::run( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
731 return $personal_urls;
732 }
733
745 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
746 $classes = [];
747 if ( $selected ) {
748 $classes[] = 'selected';
749 }
750 if ( $checkEdit && !$title->isKnown() ) {
751 $classes[] = 'new';
752 if ( $query !== '' ) {
753 $query = 'action=edit&redlink=1&' . $query;
754 } else {
755 $query = 'action=edit&redlink=1';
756 }
757 }
758
759 $linkClass = MediaWikiServices::getInstance()->getLinkRenderer()->getLinkClasses( $title );
760
761 // wfMessageFallback will nicely accept $message as an array of fallbacks
762 // or just a single key
763 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
764 if ( is_array( $message ) ) {
765 // for hook compatibility just keep the last message name
766 $message = end( $message );
767 }
768 if ( $msg->exists() ) {
769 $text = $msg->text();
770 } else {
772 $text = $wgContLang->getConverter()->convertNamespace(
773 MWNamespace::getSubject( $title->getNamespace() ) );
774 }
775
776 // Avoid PHP 7.1 warning of passing $this by reference
777 $skinTemplate = $this;
778 $result = [];
779 if ( !Hooks::run( 'SkinTemplateTabAction', [ &$skinTemplate,
780 $title, $message, $selected, $checkEdit,
781 &$classes, &$query, &$text, &$result ] ) ) {
782 return $result;
783 }
784
785 $result = [
786 'class' => implode( ' ', $classes ),
787 'text' => $text,
788 'href' => $title->getLocalURL( $query ),
789 'primary' => true ];
790 if ( $linkClass !== '' ) {
791 $result['link-class'] = $linkClass;
792 }
793
794 return $result;
795 }
796
797 function makeTalkUrlDetails( $name, $urlaction = '' ) {
798 $title = Title::newFromText( $name );
799 if ( !is_object( $title ) ) {
800 throw new MWException( __METHOD__ . " given invalid pagename $name" );
801 }
802 $title = $title->getTalkPage();
804 return [
805 'href' => $title->getLocalURL( $urlaction ),
806 'exists' => $title->isKnown(),
807 ];
808 }
809
813 function makeArticleUrlDetails( $name, $urlaction = '' ) {
814 $title = Title::newFromText( $name );
815 $title = $title->getSubjectPage();
817 return [
818 'href' => $title->getLocalURL( $urlaction ),
819 'exists' => $title->exists(),
820 ];
821 }
822
857 protected function buildContentNavigationUrls() {
859
860 // Display tabs for the relevant title rather than always the title itself
861 $title = $this->getRelevantTitle();
862 $onPage = $title->equals( $this->getTitle() );
863
864 $out = $this->getOutput();
865 $request = $this->getRequest();
866 $user = $this->getUser();
867
868 $content_navigation = [
869 'namespaces' => [],
870 'views' => [],
871 'actions' => [],
872 'variants' => []
873 ];
874
875 // parameters
876 $action = $request->getVal( 'action', 'view' );
877
878 $userCanRead = $title->quickUserCan( 'read', $user );
879
880 // Avoid PHP 7.1 warning of passing $this by reference
881 $skinTemplate = $this;
882 $preventActiveTabs = false;
883 Hooks::run( 'SkinTemplatePreventOtherActiveTabs', [ &$skinTemplate, &$preventActiveTabs ] );
884
885 // Checks if page is some kind of content
886 if ( $title->canExist() ) {
887 // Gets page objects for the related namespaces
888 $subjectPage = $title->getSubjectPage();
889 $talkPage = $title->getTalkPage();
890
891 // Determines if this is a talk page
892 $isTalk = $title->isTalkPage();
893
894 // Generates XML IDs from namespace names
895 $subjectId = $title->getNamespaceKey( '' );
896
897 if ( $subjectId == 'main' ) {
898 $talkId = 'talk';
899 } else {
900 $talkId = "{$subjectId}_talk";
901 }
902
903 $skname = $this->skinname;
904
905 // Adds namespace links
906 $subjectMsg = [ "nstab-$subjectId" ];
907 if ( $subjectPage->isMainPage() ) {
908 array_unshift( $subjectMsg, 'mainpage-nstab' );
909 }
910 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
911 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
912 );
913 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
914 $content_navigation['namespaces'][$talkId] = $this->tabAction(
915 $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
916 );
917 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
918
919 if ( $userCanRead ) {
920 // Adds "view" view link
921 if ( $title->isKnown() ) {
922 $content_navigation['views']['view'] = $this->tabAction(
923 $isTalk ? $talkPage : $subjectPage,
924 [ "$skname-view-view", 'view' ],
925 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
926 );
927 // signal to hide this from simple content_actions
928 $content_navigation['views']['view']['redundant'] = true;
929 }
930
931 $page = $this->canUseWikiPage() ? $this->getWikiPage() : false;
932 $isRemoteContent = $page && !$page->isLocal();
933
934 // If it is a non-local file, show a link to the file in its own repository
935 // @todo abstract this for remote content that isn't a file
936 if ( $isRemoteContent ) {
937 $content_navigation['views']['view-foreign'] = [
938 'class' => '',
939 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
940 setContext( $this->getContext() )->
941 params( $page->getWikiDisplayName() )->text(),
942 'href' => $page->getSourceURL(),
943 'primary' => false,
944 ];
945 }
946
947 // Checks if user can edit the current page if it exists or create it otherwise
948 if ( $title->quickUserCan( 'edit', $user )
949 && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
950 ) {
951 // Builds CSS class for talk page links
952 $isTalkClass = $isTalk ? ' istalk' : '';
953 // Whether the user is editing the page
954 $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
955 // Whether to show the "Add a new section" tab
956 // Checks if this is a current rev of talk page and is not forced to be hidden
957 $showNewSection = !$out->forceHideNewSectionLink()
958 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
959 $section = $request->getVal( 'section' );
960
961 if ( $title->exists()
962 || ( $title->getNamespace() == NS_MEDIAWIKI
963 && $title->getDefaultMessageText() !== false
964 )
965 ) {
966 $msgKey = $isRemoteContent ? 'edit-local' : 'edit';
967 } else {
968 $msgKey = $isRemoteContent ? 'create-local' : 'create';
969 }
970 $content_navigation['views']['edit'] = [
971 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
972 ? 'selected'
973 : ''
974 ) . $isTalkClass,
975 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
976 ->setContext( $this->getContext() )->text(),
977 'href' => $title->getLocalURL( $this->editUrlOptions() ),
978 'primary' => !$isRemoteContent, // don't collapse this in vector
979 ];
980
981 // section link
982 if ( $showNewSection ) {
983 // Adds new section link
984 // $content_navigation['actions']['addsection']
985 $content_navigation['views']['addsection'] = [
986 'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
987 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
988 ->setContext( $this->getContext() )->text(),
989 'href' => $title->getLocalURL( 'action=edit&section=new' )
990 ];
991 }
992 // Checks if the page has some kind of viewable source content
993 } elseif ( $title->hasSourceText() ) {
994 // Adds view source view link
995 $content_navigation['views']['viewsource'] = [
996 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
997 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
998 ->setContext( $this->getContext() )->text(),
999 'href' => $title->getLocalURL( $this->editUrlOptions() ),
1000 'primary' => true, // don't collapse this in vector
1001 ];
1002 }
1003
1004 // Checks if the page exists
1005 if ( $title->exists() ) {
1006 // Adds history view link
1007 $content_navigation['views']['history'] = [
1008 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
1009 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
1010 ->setContext( $this->getContext() )->text(),
1011 'href' => $title->getLocalURL( 'action=history' ),
1012 ];
1013
1014 if ( $title->quickUserCan( 'delete', $user ) ) {
1015 $content_navigation['actions']['delete'] = [
1016 'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
1017 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1018 ->setContext( $this->getContext() )->text(),
1019 'href' => $title->getLocalURL( 'action=delete' )
1020 ];
1021 }
1022
1023 if ( $title->quickUserCan( 'move', $user ) ) {
1024 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1025 $content_navigation['actions']['move'] = [
1026 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1027 'text' => wfMessageFallback( "$skname-action-move", 'move' )
1028 ->setContext( $this->getContext() )->text(),
1029 'href' => $moveTitle->getLocalURL()
1030 ];
1031 }
1032 } else {
1033 // article doesn't exist or is deleted
1034 if ( $user->isAllowed( 'deletedhistory' ) ) {
1035 $n = $title->isDeleted();
1036 if ( $n ) {
1037 $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1038 // If the user can't undelete but can view deleted
1039 // history show them a "View .. deleted" tab instead.
1040 $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1041 $content_navigation['actions']['undelete'] = [
1042 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1043 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1044 ->setContext( $this->getContext() )->numParams( $n )->text(),
1045 'href' => $undelTitle->getLocalURL()
1046 ];
1047 }
1048 }
1049 }
1050
1051 if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1052 MWNamespace::getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1053 ) {
1054 $mode = $title->isProtected() ? 'unprotect' : 'protect';
1055 $content_navigation['actions'][$mode] = [
1056 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1057 'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1058 ->setContext( $this->getContext() )->text(),
1059 'href' => $title->getLocalURL( "action=$mode" )
1060 ];
1061 }
1062
1063 // Checks if the user is logged in
1064 if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1074 $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1075 $content_navigation['actions'][$mode] = [
1076 'class' => 'mw-watchlink ' . (
1077 $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : ''
1078 ),
1079 // uses 'watch' or 'unwatch' message
1080 'text' => $this->msg( $mode )->text(),
1081 'href' => $title->getLocalURL( [ 'action' => $mode ] )
1082 ];
1083 }
1084 }
1085
1086 // Avoid PHP 7.1 warning of passing $this by reference
1087 $skinTemplate = $this;
1088 Hooks::run( 'SkinTemplateNavigation', [ &$skinTemplate, &$content_navigation ] );
1089
1090 if ( $userCanRead && !$wgDisableLangConversion ) {
1091 $pageLang = $title->getPageLanguage();
1092 // Gets list of language variants
1093 $variants = $pageLang->getVariants();
1094 // Checks that language conversion is enabled and variants exist
1095 // And if it is not in the special namespace
1096 if ( count( $variants ) > 1 ) {
1097 // Gets preferred variant (note that user preference is
1098 // only possible for wiki content language variant)
1099 $preferred = $pageLang->getPreferredVariant();
1100 if ( Action::getActionName( $this ) === 'view' ) {
1101 $params = $request->getQueryValues();
1102 unset( $params['title'] );
1103 } else {
1104 $params = [];
1105 }
1106 // Loops over each variant
1107 foreach ( $variants as $code ) {
1108 // Gets variant name from language code
1109 $varname = $pageLang->getVariantname( $code );
1110 // Appends variant link
1111 $content_navigation['variants'][] = [
1112 'class' => ( $code == $preferred ) ? 'selected' : false,
1113 'text' => $varname,
1114 'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ),
1115 'lang' => wfBCP47( $code ),
1116 'hreflang' => wfBCP47( $code ),
1117 ];
1118 }
1119 }
1120 }
1121 } else {
1122 // If it's not content, it's got to be a special page
1123 $content_navigation['namespaces']['special'] = [
1124 'class' => 'selected',
1125 'text' => $this->msg( 'nstab-special' )->text(),
1126 'href' => $request->getRequestURL(), // @see: T4457, T4510
1127 'context' => 'subject'
1128 ];
1129
1130 // Avoid PHP 7.1 warning of passing $this by reference
1131 $skinTemplate = $this;
1132 Hooks::run( 'SkinTemplateNavigation::SpecialPage',
1133 [ &$skinTemplate, &$content_navigation ] );
1134 }
1135
1136 // Avoid PHP 7.1 warning of passing $this by reference
1137 $skinTemplate = $this;
1138 // Equiv to SkinTemplateContentActions
1139 Hooks::run( 'SkinTemplateNavigation::Universal', [ &$skinTemplate, &$content_navigation ] );
1140
1141 // Setup xml ids and tooltip info
1142 foreach ( $content_navigation as $section => &$links ) {
1143 foreach ( $links as $key => &$link ) {
1144 $xmlID = $key;
1145 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1146 $xmlID = 'ca-nstab-' . $xmlID;
1147 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1148 $xmlID = 'ca-talk';
1149 $link['rel'] = 'discussion';
1150 } elseif ( $section == 'variants' ) {
1151 $xmlID = 'ca-varlang-' . $xmlID;
1152 } else {
1153 $xmlID = 'ca-' . $xmlID;
1154 }
1155 $link['id'] = $xmlID;
1156 }
1157 }
1158
1159 # We don't want to give the watch tab an accesskey if the
1160 # page is being edited, because that conflicts with the
1161 # accesskey on the watch checkbox. We also don't want to
1162 # give the edit tab an accesskey, because that's fairly
1163 # superfluous and conflicts with an accesskey (Ctrl-E) often
1164 # used for editing in Safari.
1165 if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1166 if ( isset( $content_navigation['views']['edit'] ) ) {
1167 $content_navigation['views']['edit']['tooltiponly'] = true;
1168 }
1169 if ( isset( $content_navigation['actions']['watch'] ) ) {
1170 $content_navigation['actions']['watch']['tooltiponly'] = true;
1171 }
1172 if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1173 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1174 }
1175 }
1176
1177 return $content_navigation;
1178 }
1179
1185 private function buildContentActionUrls( $content_navigation ) {
1186 // content_actions has been replaced with content_navigation for backwards
1187 // compatibility and also for skins that just want simple tabs content_actions
1188 // is now built by flattening the content_navigation arrays into one
1189
1190 $content_actions = [];
1191
1192 foreach ( $content_navigation as $links ) {
1193 foreach ( $links as $key => $value ) {
1194 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1195 // Redundant tabs are dropped from content_actions
1196 continue;
1197 }
1198
1199 // content_actions used to have ids built using the "ca-$key" pattern
1200 // so the xmlID based id is much closer to the actual $key that we want
1201 // for that reason we'll just strip out the ca- if present and use
1202 // the latter potion of the "id" as the $key
1203 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1204 $key = substr( $value['id'], 3 );
1205 }
1206
1207 if ( isset( $content_actions[$key] ) ) {
1208 wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1209 "content_navigation into content_actions.\n" );
1210 continue;
1211 }
1212
1213 $content_actions[$key] = $value;
1214 }
1215 }
1216
1217 return $content_actions;
1218 }
1219
1224 protected function buildNavUrls() {
1226
1227 $out = $this->getOutput();
1228 $request = $this->getRequest();
1229
1230 $nav_urls = [];
1231 $nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
1232 if ( $wgUploadNavigationUrl ) {
1233 $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1234 } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1235 $nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
1236 } else {
1237 $nav_urls['upload'] = false;
1238 }
1239 $nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
1240
1241 $nav_urls['print'] = false;
1242 $nav_urls['permalink'] = false;
1243 $nav_urls['info'] = false;
1244 $nav_urls['whatlinkshere'] = false;
1245 $nav_urls['recentchangeslinked'] = false;
1246 $nav_urls['contributions'] = false;
1247 $nav_urls['log'] = false;
1248 $nav_urls['blockip'] = false;
1249 $nav_urls['emailuser'] = false;
1250 $nav_urls['userrights'] = false;
1251
1252 // A print stylesheet is attached to all pages, but nobody ever
1253 // figures that out. :) Add a link...
1254 if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1255 $nav_urls['print'] = [
1256 'text' => $this->msg( 'printableversion' )->text(),
1257 'href' => $this->getTitle()->getLocalURL(
1258 $request->appendQueryValue( 'printable', 'yes' ) )
1259 ];
1260 }
1261
1262 if ( $out->isArticle() ) {
1263 // Also add a "permalink" while we're at it
1264 $revid = $this->getRevisionId();
1265 if ( $revid ) {
1266 $nav_urls['permalink'] = [
1267 'text' => $this->msg( 'permalink' )->text(),
1268 'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1269 ];
1270 }
1271
1272 // Avoid PHP 7.1 warning of passing $this by reference
1273 $skinTemplate = $this;
1274 // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1275 Hooks::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1276 [ &$skinTemplate, &$nav_urls, &$revid, &$revid ] );
1277 }
1278
1279 if ( $out->isArticleRelated() ) {
1280 $nav_urls['whatlinkshere'] = [
1281 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1282 ];
1283
1284 $nav_urls['info'] = [
1285 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1286 'href' => $this->getTitle()->getLocalURL( "action=info" )
1287 ];
1288
1289 if ( $this->getTitle()->exists() || $this->getTitle()->inNamespace( NS_CATEGORY ) ) {
1290 $nav_urls['recentchangeslinked'] = [
1291 'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1292 ];
1293 }
1294 }
1295
1296 $user = $this->getRelevantUser();
1297 if ( $user ) {
1298 $rootUser = $user->getName();
1299
1300 $nav_urls['contributions'] = [
1301 'text' => $this->msg( 'contributions', $rootUser )->text(),
1302 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1303 'tooltip-params' => [ $rootUser ],
1304 ];
1305
1306 $nav_urls['log'] = [
1307 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1308 ];
1309
1310 if ( $this->getUser()->isAllowed( 'block' ) ) {
1311 $nav_urls['blockip'] = [
1312 'text' => $this->msg( 'blockip', $rootUser )->text(),
1313 'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1314 ];
1315 }
1316
1317 if ( $this->showEmailUser( $user ) ) {
1318 $nav_urls['emailuser'] = [
1319 'text' => $this->msg( 'tool-link-emailuser', $rootUser )->text(),
1320 'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1321 'tooltip-params' => [ $rootUser ],
1322 ];
1323 }
1324
1325 if ( !$user->isAnon() ) {
1326 $sur = new UserrightsPage;
1327 $sur->setContext( $this->getContext() );
1328 $canChange = $sur->userCanChangeRights( $user );
1329 $nav_urls['userrights'] = [
1330 'text' => $this->msg(
1331 $canChange ? 'tool-link-userrights' : 'tool-link-userrights-readonly',
1332 $rootUser
1333 )->text(),
1334 'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1335 ];
1336 }
1337 }
1338
1339 return $nav_urls;
1340 }
1341
1346 protected function getNameSpaceKey() {
1347 return $this->getTitle()->getNamespaceKey();
1348 }
1349}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgScript
The URL path to index.php.
$wgMimeType
The default Content-Type header.
$wgDisableLangConversion
Whether to enable language variant conversion.
$wgSitename
Name of the site.
$wgUseCombinedLoginLink
Login / create account link behavior when it's possible for anonymous users to create an account.
$wgHideInterlanguageLinks
Hide interlanguage links from the sidebar.
$wgShowCreditsIfMax
If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
$wgJsMimeType
Previously used as content type in HTML script tags.
$wgFooterIcons
Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can ad...
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
$wgScriptPath
The path we should point to.
$wgStylePath
The URL path of the skins directory.
$wgServer
URL of the server.
$wgLogo
The URL path of the wiki logo.
$wgMaxCredits
Set this to the number of authors that you want to be credited below an article text.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
wfReportTime()
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition Action.php:95
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
getUser()
Get the User object.
getRequest()
Get the WebRequest object.
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
getConfig()
Get the Config object.
msg()
Get a Message object with context set Parameters are the same as wfMessage()
getTitle()
Get the Title object.
getOutput()
Get the OutputPage object.
getWikiPage()
Get the WikiPage object.
getLanguage()
Get the Language object.
getContext()
Get the base IContextSource object.
setContext(IContextSource $context)
Set the IContextSource object.
MediaWiki exception.
This serves as the entry point to the authentication system.
MediaWikiServices is the service locator for the application scope of MediaWiki.
This class should be covered by a general architecture document which does not exist as of January 20...
static instance()
Singleton.
Definition Profiler.php:62
Base class for template-based skins.
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.
string $template
For QuickTemplate, the name of the subclass which will actually fill the template.
formatLanguageName( $name)
Format language name for use in sidebar interlanguage links list.
prepareQuickTemplate()
initialize various variables and generate the template
getPersonalToolsList()
Get the HTML for the p-personal list.
buildPersonalUrls()
build array of urls for personal toolbar
buildContentNavigationUrls()
a structured array of links usually used for the tabs in a skin
useCombinedLoginLink()
Output a boolean indicating if buildPersonalUrls should output separate login and create account link...
getLanguages()
Generates array of language links for the current page.
wrapHTML( $title, $html)
Wrap the body text with language information and identifiable element.
makeTalkUrlDetails( $name, $urlaction='')
setupSkinUserCss(OutputPage $out)
Add specific styles for this skin.
outputPage(OutputPage $out=null)
initialize various variables and generate the template
buildNavUrls()
build array of common navigation links
string $skinname
Name of our skin, it probably needs to be all lower case.
buildContentActionUrls( $content_navigation)
an array of edit links by default used for the tabs
makeArticleUrlDetails( $name, $urlaction='')
tabAction( $title, $message, $selected, $query='', $checkEdit=false)
Builds an array with tab definition.
getNameSpaceKey()
Generate strings used for xml 'id' names.
printOrError( $str)
Output the string, or print error message if it's an error object of the appropriate type.
The main skin class which provides methods and properties for all other skins.
Definition Skin.php:34
aboutLink()
Gets the link to the wiki's about page.
Definition Skin.php:991
isRevisionCurrent()
Whether the revision displayed is the latest revision of the page.
Definition Skin.php:265
afterContentHook()
This runs a hook to allow extensions placing their stuff after content and article metadata (e....
Definition Skin.php:576
getNewtalks()
Gets new talk page messages for the current user and returns an appropriate alert message (or an empt...
Definition Skin.php:1366
static makeMainPageUrl( $urlaction='')
Definition Skin.php:1065
static makeKnownUrlDetails( $name, $urlaction='')
Make URL details where the article exists (or at least it's convenient to think so)
Definition Skin.php:1176
generateDebugHTML()
Generate debug data HTML for displaying at the bottom of the main content area.
Definition Skin.php:602
getCopyrightIcon()
Definition Skin.php:801
privacyLink()
Gets the link to the wiki's privacy policy page.
Definition Skin.php:983
getSiteNotice()
Get the site notice.
Definition Skin.php:1511
getUndeleteLink()
Definition Skin.php:645
getPoweredBy()
Gets the powered by MediaWiki icon.
Definition Skin.php:831
escapeSearchLink()
Definition Skin.php:747
static makeUrlDetails( $name, $urlaction='')
these return an array with the 'href' and boolean 'exists'
Definition Skin.php:1160
static makeSpecialUrlSubpage( $name, $subpage, $urlaction='')
Definition Skin.php:1098
getRelevantUser()
Return the "relevant" user.
Definition Skin.php:313
logoText( $align='')
Definition Skin.php:882
static checkTitle(&$title, $name)
make sure we have some title to operate on
Definition Skin.php:1192
editUrlOptions()
Return URL options for the 'edit page' link.
Definition Skin.php:1010
showEmailUser( $id)
Definition Skin.php:1024
buildSidebar()
Build an array that represents the sidebar(s), the navigation bar among them.
Definition Skin.php:1222
getCopyright( $type='detect')
Definition Skin.php:755
printSource()
Text with the permalink to the source page, usually shown on the footer of a printed page.
Definition Skin.php:627
getRevisionId()
Get the current revision ID.
Definition Skin.php:256
bottomScripts()
This gets called shortly before the "</body>" tag.
Definition Skin.php:611
disclaimerLink()
Gets the link to the wiki's general disclaimers page.
Definition Skin.php:999
static makeSpecialUrl( $name, $urlaction='', $proto=null)
Make a URL for a Special Page using the given query and protocol.
Definition Skin.php:1083
lastModified()
Get the timestamp of the latest revision, formatted in user language.
Definition Skin.php:855
initPage(OutputPage $out)
Definition Skin.php:144
subPageSubtitle( $out=null)
Definition Skin.php:674
getRelevantTitle()
Return the "relevant" title.
Definition Skin.php:289
getCategories()
Definition Skin.php:541
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
setContext( $context)
Sets the context this SpecialPage is executed in.
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,...
Represents a title within MediaWiki.
Definition Title.php:39
isSpecialPage()
Returns true if this is a special page.
Definition Title.php:1054
static isEnabled()
Returns true if uploads are enabled.
static isAllowed( $user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Special page to allow managing user group membership.
$res
Definition database.txt:21
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
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:57
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
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
const NS_FILE
Definition Defines.php:68
const NS_MEDIAWIKI
Definition Defines.php:70
const NS_SPECIAL
Definition Defines.php:51
const NS_CATEGORY
Definition Defines.php:76
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:249
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:2578
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1954
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:865
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:964
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 unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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:1967
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2723
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:864
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:1974
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2937
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:304
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:1601
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:2938
processing should stop and the error should be shown to the user * false
Definition hooks.txt:189
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 my talk my contributions etc & $personal_urls
Definition hooks.txt:2583
$wgArticlePath
Definition img_auth.php:45
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$params