MediaWiki  master
SkinTemplate Class Reference

Base class for template-based skins. More...

Inheritance diagram for SkinTemplate:
Collaboration diagram for SkinTemplate:

Public Member Functions

 generateHTML ()
 Subclasses not wishing to use the QuickTemplate render method can rewrite this method, for example to use TemplateParser::processTemplate. More...
 
 getPersonalToolsList ()
 Get the HTML for the p-personal list. More...
 
 getStructuredPersonalTools ()
 Get personal tools for the user. More...
 
 makeArticleUrlDetails ( $name, $urlaction='')
 
 makePersonalToolsList ( $personalTools=null, $options=[])
 Get the HTML for the personal tools list Please ensure setupTemplateContext is called before calling this method. More...
 
 outputPage ()
 Initialize various variables and generate the template @stable to override. More...
 
 tabAction ( $title, $message, $selected, $query='', $checkEdit=false)
 Builds an array with tab definition. More...
 
- Public Member Functions inherited from Skin
 __construct ( $options=null)
 
 aboutLink ()
 Gets the link to the wiki's about page. More...
 
 addToSidebar (&$bar, $message)
 Add content from a sidebar system message Currently only used for MediaWiki:Sidebar (but may be used by Extensions) More...
 
 addToSidebarPlain (&$bar, $text)
 Add content from plain text. More...
 
 bottomScripts ()
 This gets called shortly before the "</body>" tag. More...
 
 buildSidebar ()
 Build an array that represents the sidebar(s), the navigation bar among them. More...
 
 disclaimerLink ()
 Gets the link to the wiki's general disclaimers page. More...
 
 doEditSectionLink (Title $nt, $section, $tooltip, Language $lang)
 Create a section edit link. More...
 
 editUrlOptions ()
 Return URL options for the 'edit page' link. More...
 
 footerLink ( $desc, $page)
 Given a pair of message keys for link and text label, return an HTML link for use in the footer. More...
 
 getAfterPortlet (string $name)
 Allows extensions to hook into known portlets and add stuff to them. More...
 
 getCategories ()
 
 getCategoryLinks ()
 
 getCopyright ( $type='detect')
 
 getDefaultModules ()
 Defines the ResourceLoader modules that should be added to the skin It is recommended that skins wishing to override call parent::getDefaultModules() and substitute out any modules they wish to change by using a key to look them up. More...
 
 getHtmlElementAttributes ()
 Return values for <html> element. More...
 
 getIndicatorsHTML ( $indicators)
 Get the suggested HTML for page status indicators: icons (or short text snippets) usually displayed in the top-right corner of the page, outside of the main content. More...
 
 getLanguages ()
 Generates array of language links for the current page. More...
 
 getNewtalks ()
 Gets new talk page messages for the current user and returns an appropriate alert message (or an empty string if there are no messages) More...
 
 getPageClasses ( $title)
 TODO: document. More...
 
 getPersonalToolsForMakeListItem ( $urls)
 Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate. More...
 
 getRelevantTitle ()
 Return the "relevant" title. More...
 
 getRelevantUser ()
 Return the "relevant" user. More...
 
 getRevisionId ()
 Get the current revision ID. More...
 
 getSiteFooterLinks ()
 Gets the link to the wiki's privacy policy, about page, and disclaimer page. More...
 
 getSiteNotice ()
 Get the site notice. More...
 
 getSkinName ()
 
 getSkinStylePath ( $name)
 Return a fully resolved style path URL to images or styles stored in the current skin's folder. More...
 
 getUndeleteLink ()
 
 initPage (OutputPage $out)
 Stable to override. More...
 
 isResponsive ()
 Indicates if this skin is responsive. More...
 
 isRevisionCurrent ()
 Whether the revision displayed is the latest revision of the page. More...
 
 logoText ( $align='')
 
 mainPageLink ()
 Gets the link to the wiki's main page. More...
 
 makeFooterIcon ( $icon, $withImage='withImage')
 Renders a $wgFooterIcons icon according to the method's arguments. More...
 
 makeLink ( $key, $item, $options=[])
 Makes a link, usually used by makeListItem to generate a link for an item in a list used in navigation lists, portlets, portals, sidebars, etc... More...
 
 makeListItem ( $key, $item, $options=[])
 Generates a list item for a navigation, portlet, portal, sidebar... More...
 
 makeSearchButton ( $mode, $attrs=[])
 
 makeSearchInput ( $attrs=[])
 
 makeToolbox ( $navUrls, $feedUrls)
 Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate. More...
 
 mapInterwikiToLanguage ( $code)
 Allows correcting the language of interlanguage links which, mostly due to legacy reasons, do not always match the standards compliant language tag. More...
 
 printSource ()
 Text with the permalink to the source page, usually shown on the footer of a printed page. More...
 
 privacyLink ()
 Gets the link to the wiki's privacy policy page. More...
 
 setRelevantTitle ( $t)
 Set the "relevant" title. More...
 
 setRelevantUser ( $u)
 Set the "relevant" user. More...
 
 setupSkinUserCss (OutputPage $out)
 Hook point for adding style modules to OutputPage. More...
 
 showEmailUser ( $id)
 
 subPageSubtitle ( $out=null)
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 Stable to override. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Public Attributes

 $loggedin
 
string $template = QuickTemplate::class
 For QuickTemplate, the name of the subclass which will actually fill the template. More...
 
 $thispage
 
 $thisquery
 
 $titletxt
 
 $username
 
 $userpage
 
 $userpageUrlDetails
 
- Public Attributes inherited from Skin
string $stylename = null
 Stylesheets set to use. More...
 

Protected Member Functions

 buildContentNavigationUrls ()
 a structured array of links usually used for the tabs in a skin More...
 
 buildNavUrls ()
 build array of common navigation links and run the SkinTemplateBuildNavUrlsNav_urlsAfterPermalink hook. More...
 
 buildPersonalUrls ()
 build array of urls for personal toolbar Please ensure setupTemplateContext is called before calling this method. More...
 
 getFooterIcons ()
 Get template representation of the footer. More...
 
 getFooterLinks ()
 Get template representation of the footer containing site footer links as well as standard footer links. More...
 
 getJsConfigVars ()
 Returns array of config variables that should be added only to this skin for use in JavaScript. More...
 
 getNameSpaceKey ()
 Generate strings used for xml 'id' names. More...
 
 prepareQuickTemplate ()
 initialize various variables and generate the template More...
 
 prepareSubtitle ()
 Prepare the subtitle of the page for output in the skin if one has been set. More...
 
 prepareUndeleteLink ()
 Prepare undelete link for output in page. More...
 
 prepareUserLanguageAttributes ()
 Prepare user language attribute links. More...
 
 setupTemplate ( $classname)
 Create the template engine object; we feed it a bunch of data and eventually it spits out some HTML. More...
 
 setupTemplateContext ()
 Setup class properties that are necessary prior to calling setupTemplateForOutput. More...
 
 setupTemplateForOutput ()
 
 wrapHTML ( $title, $html)
 Wrap the body text with language information and identifiable element. More...
 
- Protected Member Functions inherited from Skin
 afterContentHook ()
 This runs a hook to allow extensions placing their stuff after content and article metadata (e.g. More...
 
 buildFeedUrls ()
 Build data structure representing syndication links. More...
 
 drawCategoryBrowser ( $tree)
 Render the array as a series of links. More...
 
 generateDebugHTML ()
 Generate debug data HTML for displaying at the bottom of the main content area. More...
 
 getCopyrightIcon ()
 
 getIndicatorsData ( $indicators)
 Return an array of indicator data. More...
 
 getLogo ()
 URL to the default square logo (1x key) More...
 
 getPoweredBy ()
 Gets the powered by MediaWiki icon. More...
 
 getSearchLink ()
 
 lastModified ()
 Get the timestamp of the latest revision, formatted in user language. More...
 
 preloadExistence ()
 Preload the existence of three commonly-requested pages in a single query. More...
 

Private Member Functions

 buildContentActionUrls ( $content_navigation)
 an array of edit links by default used for the tabs More...
 
 getWatchLinkAttrs (string $mode, User $user, Title $title, ?string $action, bool $onPage)
 Get the attributes for the watch link. More...
 
 makeTalkUrlDetails ( $name, $urlaction='')
 

Additional Inherited Members

- Static Public Member Functions inherited from Skin
static checkTitle (&$title, $name)
 make sure we have some title to operate on More...
 
static getAllowedSkins ()
 Fetch the list of user-selectable skins in regards to $wgSkipSkins. More...
 
static getSkinNames ()
 Fetch the set of available skins. More...
 
static makeInternalOrExternalUrl ( $name)
 If url string starts with http, consider as external URL, else internal. More...
 
static makeMainPageUrl ( $urlaction='')
 
static makeNSUrl ( $name, $urlaction='', $namespace=NS_MAIN)
 this can be passed the NS number as defined in Language.php More...
 
static makeSpecialUrl ( $name, $urlaction='', $proto=null)
 Make a URL for a Special Page using the given query and protocol. More...
 
static makeSpecialUrlSubpage ( $name, $subpage, $urlaction='')
 
static makeUrl ( $name, $urlaction='')
 
static makeVariablesScript ( $data, $nonce=null)
 
static normalizeKey ( $key)
 Normalize a skin preference value to a form that can be loaded. More...
 
- Static Protected Member Functions inherited from Skin
static makeKnownUrlDetails ( $name, $urlaction='')
 Make URL details where the article exists (or at least it's convenient to think so) More...
 
static makeUrlDetails ( $name, $urlaction='')
 these return an array with the 'href' and boolean 'exists' More...
 
- Protected Attributes inherited from Skin
 $mRelevantTitle = null
 
 $mRelevantUser = null
 
array $options = []
 Skin options passed into constructor. More...
 
string null $skinname = null
 

Detailed Description

Base class for template-based skins.

Template-filler skin base class Formerly generic PHPTal (http://phptal.sourceforge.net/) skin Based on Brion's smarty skin

Note
Copyright © Gabriel Wicke – http://www.aulinx.de/
Todo:
Needs some serious refactoring into functions that correspond to the computations individual esi snippets need. Most importantly no body parsing for most of those of course.

Stable to extend

Definition at line 39 of file SkinTemplate.php.

Member Function Documentation

◆ buildContentActionUrls()

SkinTemplate::buildContentActionUrls (   $content_navigation)
private

an array of edit links by default used for the tabs

Parameters
array$content_navigation
Returns
array

Definition at line 1197 of file SkinTemplate.php.

References wfDebug().

Referenced by prepareQuickTemplate().

◆ buildContentNavigationUrls()

SkinTemplate::buildContentNavigationUrls ( )
protected

a structured array of links usually used for the tabs in a skin

There are 4 standard sections namespaces: Used for namespace tabs like special, page, and talk namespaces views: Used for primary page views like read, edit, history actions: Used for most extra page actions like deletion, protection, etc... variants: Used to list the language variants for the page

Each section's value is a key/value array of links for that section. The links themselves have these common keys:

  • class: The css classes to apply to the tab
  • text: The text to display on the tab
  • href: The href for the tab to point to
  • rel: An optional rel= for the tab's link
  • redundant: If true the tab will be dropped in skins using content_actions this is useful for tabs like "Read" which only have meaning in skins that take special meaning from the grouped structure of content_navigation

Views also have an extra key which can be used:

  • primary: If this is not true skins like vector may try to hide the tab when the user has limited space in their browser window

content_navigation using code also expects these ids to be present on the links, however these are usually automatically generated by SkinTemplate itself and are not necessary when using a hook. The only things these may matter to are people modifying content_navigation after it's initial creation:

  • id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility.
  • tooltiponly: This is set to true for some tabs in cases where the system believes that the accesskey should not be added to the tab.
Returns
array

Definition at line 868 of file SkinTemplate.php.

References Skin\$skinname, $title, LanguageCode\bcp47(), ContextSource\canUseWikiPage(), Skin\editUrlOptions(), Action\getActionName(), ContextSource\getConfig(), ContextSource\getContext(), ContextSource\getOutput(), Skin\getRelevantTitle(), ContextSource\getRequest(), ContextSource\getTitle(), SpecialPage\getTitleFor(), ContextSource\getUser(), getWatchLinkAttrs(), ContextSource\getWikiPage(), ContextSource\msg(), NS_MEDIAWIKI, ContextSource\setContext(), tabAction(), and wfMessageFallback().

Referenced by prepareQuickTemplate().

◆ buildNavUrls()

SkinTemplate::buildNavUrls ( )
protected

build array of common navigation links and run the SkinTemplateBuildNavUrlsNav_urlsAfterPermalink hook.

Build array of common navigation links.Assumes thispage property has been set before execution.

Since
1.35
Returns
array

Returns
array

Reimplemented from Skin.

Definition at line 1238 of file SkinTemplate.php.

References ContextSource\getOutput().

Referenced by prepareQuickTemplate().

◆ buildPersonalUrls()

SkinTemplate::buildPersonalUrls ( )
protected

◆ generateHTML()

SkinTemplate::generateHTML ( )

Subclasses not wishing to use the QuickTemplate render method can rewrite this method, for example to use TemplateParser::processTemplate.

Since
1.35
Returns
string of complete document HTML to output to the page which includes <!DOCTYPE> and opening and closing html tags.

Reimplemented in SkinMustache.

Definition at line 120 of file SkinTemplate.php.

References prepareQuickTemplate().

Referenced by outputPage().

◆ getFooterIcons()

SkinTemplate::getFooterIcons ( )
protected

Get template representation of the footer.

Since
1.35
Returns
array

Definition at line 221 of file SkinTemplate.php.

References ContextSource\getConfig().

Referenced by prepareQuickTemplate().

◆ getFooterLinks()

SkinTemplate::getFooterLinks ( )
protected

Get template representation of the footer containing site footer links as well as standard footer links.

All values are resolved and can be added to by the SkinAddFooterLinks hook.

Since
1.35

Definition at line 253 of file SkinTemplate.php.

References $title, $wgMaxCredits, $wgShowCreditsIfMax, Action\factory(), ContextSource\getConfig(), ContextSource\getContext(), Skin\getCopyright(), ContextSource\getOutput(), Skin\getSiteFooterLinks(), ContextSource\getSkin(), ContextSource\getWikiPage(), Skin\lastModified(), and Article\newFromWikiPage().

Referenced by prepareQuickTemplate().

◆ getJsConfigVars()

SkinTemplate::getJsConfigVars ( )
protected

Returns array of config variables that should be added only to this skin for use in JavaScript.

Skins can override this to add variables to the page.

Since
1.35
Returns
array

Definition at line 148 of file SkinTemplate.php.

Referenced by outputPage().

◆ getNameSpaceKey()

SkinTemplate::getNameSpaceKey ( )
protected

Generate strings used for xml 'id' names.

Deprecated:
since 1.35, use Title::getNamespaceKey() instead
Returns
string

Definition at line 1264 of file SkinTemplate.php.

References ContextSource\getTitle().

◆ getPersonalToolsList()

SkinTemplate::getPersonalToolsList ( )

Get the HTML for the p-personal list.

Deprecated:
since 1.35, use SkinTemplate::makePersonalToolsList()
Returns
string

Definition at line 478 of file SkinTemplate.php.

References makePersonalToolsList().

◆ getStructuredPersonalTools()

SkinTemplate::getStructuredPersonalTools ( )

Get personal tools for the user.

Since
1.31
Returns
array Array of personal tools

Definition at line 516 of file SkinTemplate.php.

References buildPersonalUrls(), Skin\getPersonalToolsForMakeListItem(), and setupTemplateContext().

◆ getWatchLinkAttrs()

SkinTemplate::getWatchLinkAttrs ( string  $mode,
User  $user,
Title  $title,
?string  $action,
bool  $onPage 
)
private

Get the attributes for the watch link.

Parameters
string$modeEither 'watch' or 'unwatch'
User$user
Title$title
string | null$action
bool$onPage
Returns
array

Definition at line 807 of file SkinTemplate.php.

References $title, ContextSource\getConfig(), User\isTempWatched(), and ContextSource\msg().

Referenced by buildContentNavigationUrls().

◆ makeArticleUrlDetails()

SkinTemplate::makeArticleUrlDetails (   $name,
  $urlaction = '' 
)
Deprecated:
since 1.35, no longer used
Parameters
string$name
string | array$urlaction
Returns
array

Definition at line 787 of file SkinTemplate.php.

References $title, Skin\checkTitle(), Title\newFromText(), and wfDeprecated().

◆ makePersonalToolsList()

SkinTemplate::makePersonalToolsList (   $personalTools = null,
  $options = [] 
)

Get the HTML for the personal tools list Please ensure setupTemplateContext is called before calling this method.

Since
1.31
Parameters
array | null$personalTools
array$options
Returns
string

Definition at line 492 of file SkinTemplate.php.

References Skin\$options, buildPersonalUrls(), Skin\getPersonalToolsForMakeListItem(), Skin\makeListItem(), and setupTemplateContext().

Referenced by getPersonalToolsList().

◆ makeTalkUrlDetails()

SkinTemplate::makeTalkUrlDetails (   $name,
  $urlaction = '' 
)
private
Parameters
string$name
string | array$urlaction
Returns
array

Definition at line 768 of file SkinTemplate.php.

References $title, Skin\checkTitle(), and Title\newFromText().

Referenced by buildPersonalUrls().

◆ outputPage()

SkinTemplate::outputPage ( )

Initialize various variables and generate the template @stable to override.

Reimplemented from Skin.

Definition at line 130 of file SkinTemplate.php.

References generateHTML(), getJsConfigVars(), ContextSource\getOutput(), Skin\initPage(), and Profiler\instance().

◆ prepareQuickTemplate()

◆ prepareSubtitle()

SkinTemplate::prepareSubtitle ( )
finalprotected

Prepare the subtitle of the page for output in the skin if one has been set.

Since
1.35
Returns
string HTML

Definition at line 184 of file SkinTemplate.php.

References ContextSource\getOutput(), and Skin\subPageSubtitle().

Referenced by SkinMustache\getTemplateData(), and prepareQuickTemplate().

◆ prepareUndeleteLink()

SkinTemplate::prepareUndeleteLink ( )
finalprotected

Prepare undelete link for output in page.

Since
1.35
Returns
null|string HTML, or null if there is no undelete link.

Definition at line 300 of file SkinTemplate.php.

References Skin\getUndeleteLink().

Referenced by SkinMustache\getTemplateData(), and prepareQuickTemplate().

◆ prepareUserLanguageAttributes()

SkinTemplate::prepareUserLanguageAttributes ( )
finalprotected

Prepare user language attribute links.

Since
1.35
Returns
string HTML attributes

Definition at line 198 of file SkinTemplate.php.

References ContextSource\getLanguage().

Referenced by SkinMustache\getTemplateData(), and prepareQuickTemplate().

◆ setupTemplate()

SkinTemplate::setupTemplate (   $classname)
protected

Create the template engine object; we feed it a bunch of data and eventually it spits out some HTML.

Should have interface roughly equivalent to PHPTAL 0.7.

Parameters
string$classname
Returns
QuickTemplate

Definition at line 62 of file SkinTemplate.php.

References ContextSource\getConfig().

Referenced by setupTemplateForOutput().

◆ setupTemplateContext()

SkinTemplate::setupTemplateContext ( )
finalprotected

Setup class properties that are necessary prior to calling setupTemplateForOutput.

It must be called inside prepareQuickTemplate. This function may set local class properties that will be used by other methods, but should not make assumptions about the implementation of setupTemplateForOutput

Since
1.35

Definition at line 84 of file SkinTemplate.php.

References $title, ContextSource\getRequest(), ContextSource\getTitle(), ContextSource\getUser(), Skin\makeKnownUrlDetails(), Skin\makeUrlDetails(), and wfArrayToCgi().

Referenced by SkinMustache\generateHTML(), getStructuredPersonalTools(), makePersonalToolsList(), and setupTemplateForOutput().

◆ setupTemplateForOutput()

SkinTemplate::setupTemplateForOutput ( )
protected
Returns
QuickTemplate

Definition at line 69 of file SkinTemplate.php.

References setupTemplate(), and setupTemplateContext().

Referenced by prepareQuickTemplate().

◆ tabAction()

SkinTemplate::tabAction (   $title,
  $message,
  $selected,
  $query = '',
  $checkEdit = false 
)

Builds an array with tab definition.

Parameters
Title$titlePage Where the tab links to
string | array$messageMessage key or an array of message keys (will fall back)
bool$selectedDisplay the tab as selected
string$queryQuery string attached to tab URL
bool$checkEditCheck if $title exists and mark with .new if one doesn't
Returns
array

Definition at line 706 of file SkinTemplate.php.

References $title, ContextSource\getContext(), true, and wfMessageFallback().

Referenced by buildContentNavigationUrls().

◆ wrapHTML()

SkinTemplate::wrapHTML (   $title,
  $html 
)
protected

Wrap the body text with language information and identifiable element.

Parameters
Title$title
string$htmlbody text
Returns
string html

Definition at line 159 of file SkinTemplate.php.

References $title, Action\getActionName(), NS_FILE, NS_SPECIAL, and Html\rawElement().

Referenced by SkinMustache\getTemplateData(), and prepareQuickTemplate().

Member Data Documentation

◆ $loggedin

SkinTemplate::$loggedin

Definition at line 50 of file SkinTemplate.php.

◆ $template

string SkinTemplate::$template = QuickTemplate::class

For QuickTemplate, the name of the subclass which will actually fill the template.

Child classes should override the default.

Definition at line 44 of file SkinTemplate.php.

Referenced by SkinMustache\generateHTML().

◆ $thispage

SkinTemplate::$thispage

Definition at line 46 of file SkinTemplate.php.

◆ $thisquery

SkinTemplate::$thisquery

Definition at line 49 of file SkinTemplate.php.

◆ $titletxt

SkinTemplate::$titletxt

Definition at line 47 of file SkinTemplate.php.

◆ $username

SkinTemplate::$username

Definition at line 51 of file SkinTemplate.php.

Referenced by buildPersonalUrls().

◆ $userpage

SkinTemplate::$userpage

Definition at line 48 of file SkinTemplate.php.

◆ $userpageUrlDetails

SkinTemplate::$userpageUrlDetails

Definition at line 52 of file SkinTemplate.php.


The documentation for this class was generated from the following file: