The main skin class which provides methods and properties for all other skins. More...

Inheritance diagram for Skin:

[legend]

Collaboration diagram for Skin:

[legend]

Public Member Functions
	__construct ( $options=null)

	aboutLink ()
	Gets the link to the wiki's about page.

	addToSidebar (&$bar, $message)
	Add content from a sidebar system message Currently only used for MediaWiki:Sidebar (but may be used by Extensions)

	addToSidebarPlain (&$bar, $text)
	Add content from plain text.

	bottomScripts ()
	This gets called shortly before the "</body>" tag.

	buildSidebar ()
	Build an array that represents the sidebar(s), the navigation bar among them.

	disclaimerLink ()
	Gets the link to the wiki's general disclaimers page.

	doEditSectionLink (Title $nt, $section, $tooltip, Language $lang)
	Create a section edit link.

	doSetupSkinUserCss (OutputPage $out)
	Call the subclass's setupSkinUserCss and throw a deprecation warning if required.

	editUrlOptions ()
	Return URL options for the 'edit page' link.

	footerLink ( $desc, $page)
	Given a pair of message keys for link and text label, return an HTML link for use in the footer.

	getAfterPortlet (string $name)
	Allows extensions to hook into known portlets and add stuff to them.

	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.

	getHtmlElementAttributes ()
	Return values for <html> element.

	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.

	getLanguages ()
	Generates array of language links for the current page.

	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)

	getPageClasses ( $title)
	TODO: document.

	getPersonalToolsForMakeListItem ( $urls)
	Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate.

	getRelevantTitle ()
	Return the "relevant" title.

	getRelevantUser ()
	Return the "relevant" user.

	getRevisionId ()
	Get the current revision ID.

	getSearchPageTitle ()

	getSiteFooterLinks ()
	Gets the link to the wiki's privacy policy, about page, and disclaimer page.

	getSiteNotice ()

	getSkinName ()

	getSkinStylePath ( $name)
	Return a fully resolved style path URL to images or styles stored in the current skin's folder.

	getUndeleteLink ()

	initPage (OutputPage $out)

	isResponsive ()
	Indicates if this skin is responsive.

	isRevisionCurrent ()
	Whether the revision displayed is the latest revision of the page.

	logoText ( $align='')

	mainPageLink ()
	Gets the link to the wiki's main page.

	makeFooterIcon ( $icon, $withImage='withImage')
	Renders a $wgFooterIcons icon according to the method's arguments.

	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...

	makeListItem ( $key, $item, $options=[])
	Generates a list item for a navigation, portlet, portal, sidebar... list.

	makeSearchButton ( $mode, $attrs=[])

	makeSearchInput ( $attrs=[])

	makeToolbox ( $navUrls, $feedUrls)
	Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate.

	mapInterwikiToLanguage ( $code)
	Allows correcting the language of interlanguage links which, mostly due to legacy reasons, do not always match the standards compliant language tag.

	outputPage ()
	Outputs the HTML generated by other functions.

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

	printSource ()
	Text with the permalink to the source page, usually shown on the footer of a printed page.

	privacyLink ()
	Gets the link to the wiki's privacy policy page.

	setRelevantTitle ( $t)

	setRelevantUser (User $u)

	setSearchPageTitle (Title $title)

	setupSkinUserCss (OutputPage $out)
	Hook point for adding style modules to OutputPage.

	showEmailUser ( $id)

	subPageSubtitle ( $out)

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Static Public Member Functions
static	checkTitle (&$title, $name)
	make sure we have some title to operate on

static	getAllowedSkins ()
	Fetch the list of user-selectable skins in regards to $wgSkipSkins.

static	getSkinNames ()
	Fetch the set of available skins.

static	getVersion ()
	Get the current major version of Skin.

static	makeInternalOrExternalUrl ( $name)
	If url string starts with http, consider as external URL, else internal.

static	makeMainPageUrl ( $urlaction='')

static	makeNSUrl ( $name, $urlaction='', $namespace=NS_MAIN)
	this can be passed the NS number as defined in Language.php

static	makeSpecialUrl ( $name, $urlaction='', $proto=null)
	Make a URL for a Special Page using the given query and protocol.

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.

Public Attributes
string	$stylename = null
	Stylesheets set to use.

Protected Member Functions
	afterContentHook ()
	This runs a hook to allow extensions placing their stuff after content and article metadata (e.g.

	buildFeedUrls ()
	Build data structure representing syndication links.

	buildNavUrls ()
	Build array of common navigation links.

	drawCategoryBrowser ( $tree)
	Render the array as a series of links.

	generateDebugHTML ()
	Generate debug data HTML for displaying at the bottom of the main content area.

	getCopyrightIcon ()

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

	getIndicatorsData ( $indicators)
	Return an array of indicator data.

	getLogo ()
	URL to the default square logo (1x key)

	getPoweredBy ()
	Gets the powered by MediaWiki icon.

	getSearchLink ()

	lastModified ()
	Get the timestamp of the latest revision, formatted in user language.

	preloadExistence ()
	Preload the existence of three commonly-requested pages in a single query.

Static Protected Member Functions
static	makeKnownUrlDetails ( $name, $urlaction='')
	Make URL details where the article exists (or at least it's convenient to think so)

static	makeUrlDetails ( $name, $urlaction='')
	these return an array with the 'href' and boolean 'exists'

Protected Attributes
	$mRelevantTitle = null

User null	$mRelevantUser = null

array	$options = []
	Skin options passed into constructor.

string null	$skinname = null

const	VERSION_MAJOR = 1
	The current major version of the skin specification.

Private Member Functions
	footerLinkTitle ( $desc, $page)

	getCachedNotice ( $name)
	Get a cached notice.

	subPageSubtitleInternal ()

Private Attributes
	$searchPageTitle = null

Detailed Description

The main skin class which provides methods and properties for all other skins.

See docs/Skin.md for more information.

Stability: stable: to extend

Definition at line 42 of file Skin.php.

Constructor & Destructor Documentation

◆ __construct()

Skin::__construct ( $options = null )

Since: 1.31

Parameters

string | array | null $options Options for the skin can be an array since 1.35. When a string is passed, it's the skinname. When an array is passed; name key represents the skinname, defaults to $wgDefaultSkin if not provided scripts represents an array of ResourceLoader script modules and styles represents an array of ResourceLoader style modules to load on all pages. responsive indicates if a viewport meta tag should be set.

Definition at line 173 of file Skin.php.

Member Function Documentation

◆ aboutLink()

Skin::aboutLink ( )

Gets the link to the wiki's about page.

Deprecated:: since 1.36, use self::footerLink();

Returns: string HTML

Definition at line 1228 of file Skin.php.

References footerLink(), and wfDeprecated().

◆ addToSidebar()

Skin::addToSidebar	(	&	$bar,
			$message
	)

Add content from a sidebar system message Currently only used for MediaWiki:Sidebar (but may be used by Extensions)

This is just a wrapper around addToSidebarPlain() for backwards compatibility

Parameters

array	&$bar
string	$message

Definition at line 1795 of file Skin.php.

References addToSidebarPlain(), and ContextSource\msg().

Referenced by buildSidebar().

◆ addToSidebarPlain()

Skin::addToSidebarPlain	(	&	$bar,
			$text
	)

Add content from plain text.

Since: 1.17

Parameters

array	&$bar
string	$text

Returns: array

Definition at line 1806 of file Skin.php.

References $line, $lines, $title, ContextSource\getConfig(), getTitle(), ContextSource\msg(), wfMatchesDomainList(), and wfUrlProtocols().

Referenced by addToSidebar().

◆ afterContentHook()

Skin::afterContentHook ( )

protected

This runs a hook to allow extensions placing their stuff after content and article metadata (e.g.

categories). Note: This function has nothing to do with afterContent().

This hook is placed here in order to allow using the same hook for all skins, both the SkinTemplate based ones and the older ones, which directly use this class to get their data.

The output of this function gets processed in SkinTemplate::outputPage() for the SkinTemplate based skins, all other skins should directly echo it.

Returns: string Empty by default, if not changed by any hook function.

Definition at line 715 of file Skin.php.

References wfDebug().

Referenced by SkinMustache\getTemplateData().

◆ bottomScripts()

Skin::bottomScripts ( )

This gets called shortly before the "</body>" tag.

Returns: string|WrappedStringList HTML containing scripts to put before </body>

Definition at line 753 of file Skin.php.

References ContextSource\getOutput().

◆ buildFeedUrls()

Skin::buildFeedUrls ( )

finalprotected

Build data structure representing syndication links.

Since: 1.35

Returns: array

Definition at line 1701 of file Skin.php.

References ContextSource\getOutput(), and ContextSource\msg().

Referenced by buildSidebar().

◆ buildNavUrls()

Skin::buildNavUrls ( )

protected

Build array of common navigation links.

Assumes thispage property has been set before execution.

Since: 1.35

Returns: array

Reimplemented in SkinTemplate.

Definition at line 1565 of file Skin.php.

References $title, getAuthority(), ContextSource\getConfig(), getContext(), ContextSource\getOutput(), getRelevantUser(), getTitle(), SpecialPage\getTitleFor(), ContextSource\getUser(), ContextSource\msg(), NS_CATEGORY, SpecialPage\setContext(), and showEmailUser().

Referenced by buildSidebar().

◆ buildSidebar()

Skin::buildSidebar ( )

Build an array that represents the sidebar(s), the navigation bar among them.

BaseTemplate::getSidebar can be used to simplify the format and id generation in new skins.

The format of the returned array is [ heading => content, ... ], where:

heading is the heading of a navigation portlet. It is either:
- magic string to be handled by the skins ('SEARCH' / 'LANGUAGES' / 'TOOLBOX' / ...)
  - Note that 'SEARCH' unlike others is not supported out-of-the-box by the skins.
  - For it to work, a skin must add custom support for it.
- a message name (e.g. 'navigation'), the message should be HTML-escaped by the skin
- plain text, which should be HTML-escaped by the skin
content is the contents of the portlet. This must be array of link data in a format accepted by self::makeListItem().
- (for a magic string as a key, any value)

Note that extensions can control the sidebar contents using the SkinBuildSidebar hook and can technically insert anything in here; skin creators are expected to handle values described above.

Stability: stable: to override

Returns: array

Definition at line 1740 of file Skin.php.

References addToSidebar(), buildFeedUrls(), buildNavUrls(), ContextSource\getConfig(), ContextSource\getLanguage(), getLanguages(), and makeToolbox().

Referenced by SkinMustache\getPortletsTemplateData().

◆ checkTitle()

static Skin::checkTitle	(	&	$title,
			$name
	)

static

make sure we have some title to operate on

Parameters

Title	&$title
string	$name

Definition at line 1429 of file Skin.php.

References $title.

◆ disclaimerLink()

Skin::disclaimerLink ( )

Gets the link to the wiki's general disclaimers page.

Deprecated:: since 1.36, use self::footerLink();

Returns: string HTML

Definition at line 1239 of file Skin.php.

References footerLink(), and wfDeprecated().

◆ doEditSectionLink()

Skin::doEditSectionLink	(	Title	$nt,
			$section,
			$tooltip,
		Language	$lang
	)

Create a section edit link.

Parameters

Title	$nt	The title being linked to (may not be the same as the current page, if the section is included from a template)
string	$section	The designation of the section being pointed to, to be included in the link, like "&section=$section"
string \| null	$tooltip	The tooltip to use for the link: will be escaped and wrapped in the 'editsectionhint' message
Language	$lang

Returns: string HTML to use for edit link

Definition at line 2089 of file Skin.php.

References $lang, and ContextSource\msg().

◆ doSetupSkinUserCss()

Skin::doSetupSkinUserCss ( OutputPage $out )

final

Call the subclass's setupSkinUserCss and throw a deprecation warning if required.

Parameters

OutputPage $out

Access: internal: only for use in Skin or inside OutputPage and ApiParse where support for setupSkinUserCss is required.

Definition at line 500 of file Skin.php.

References setupSkinUserCss().

◆ drawCategoryBrowser()

Skin::drawCategoryBrowser ( $tree )

protected

Render the array as a series of links.

Parameters

array $tree Categories tree returned by Title::getParentCategoryTree

Returns: string Separated by >, terminate with "\\n"

Definition at line 656 of file Skin.php.

References drawCategoryBrowser().

Referenced by drawCategoryBrowser(), and getCategoryLinks().

◆ editUrlOptions()

Skin::editUrlOptions ( )

Return URL options for the 'edit page' link.

This may include an 'oldid' specifier, if the current page view is such.

Returns: array

Access: internal

Definition at line 1251 of file Skin.php.

References ContextSource\getOutput().

◆ footerLink()

Skin::footerLink	(	$desc,
		$page
	)

Given a pair of message keys for link and text label, return an HTML link for use in the footer.

Parameters

string	$desc	The i18n message key for the link text. The content of this message will be the visibile text label. If this is set to nonexisting message key or the message is disabled, the link will not be generated, empty string will be returned in the stead.
string	$page	The i18n message key for the page to link to. The content of this message will be the destination page for the footer link. Given a messsage key 'Privacypage' with content 'Project:Privacy policy', the link will lead to the wiki page with the title of the content.

Returns: string HTML anchor

Definition at line 1141 of file Skin.php.

References $title, footerLinkTitle(), and ContextSource\msg().

Referenced by aboutLink(), disclaimerLink(), getSiteFooterLinks(), and privacyLink().

◆ footerLinkTitle()

Skin::footerLinkTitle	(	$desc,
		$page
	)

private

Parameters

string	$desc
string	$page

Returns: Title|null

Definition at line 1160 of file Skin.php.

References $title, and ContextSource\msg().

Referenced by footerLink(), and preloadExistence().

◆ generateDebugHTML()

Skin::generateDebugHTML ( )

protected

Generate debug data HTML for displaying at the bottom of the main content area.

Returns: string HTML containing debug data, if enabled (otherwise empty).

Deprecated:: since 1.35. Call MWDebug::getHTMLDebugLog() directly.

Definition at line 743 of file Skin.php.

References wfDeprecated().

◆ getAfterPortlet()

Skin::getAfterPortlet ( string $name )

Allows extensions to hook into known portlets and add stuff to them.

Unlike its BaseTemplate counterpart, this method does not wrap the html provided by the hook in a div.

Parameters

string $name

Returns: string html

Since: 1.35

Definition at line 2605 of file Skin.php.

Referenced by SkinMustache\getPortletData().

◆ getAllowedSkins()

static Skin::getAllowedSkins ( )

static

Fetch the list of user-selectable skins in regards to $wgSkipSkins.

Useful for Special:Preferences and other places where you only want to show skins users can use.

Since: 1.23

Deprecated:: since 1.36. Use SkinFactory::getAllowedSkins() instead.

Returns: string[]

Definition at line 105 of file Skin.php.

References wfDeprecated().

◆ getCachedNotice()

Skin::getCachedNotice ( $name )

private

Get a cached notice.

Parameters

string $name Message name, or 'default' for $wgSiteNotice

Returns: string|bool HTML fragment, or false to indicate that the caller should fall back to the next notice in its sequence

Definition at line 2007 of file Skin.php.

References $cache, ContextSource\getConfig(), ContextSource\getOutput(), and ContextSource\msg().

Referenced by getSiteNotice().

◆ getCategories()

Skin::getCategories ( )

Returns: string HTML

Definition at line 680 of file Skin.php.

References getCategoryLinks(), ContextSource\getOutput(), getTitle(), ContextSource\getUser(), and NS_CATEGORY.

Referenced by SkinMustache\getTemplateData().

◆ getCategoryLinks()

Skin::getCategoryLinks ( )

Returns: string HTML

Definition at line 581 of file Skin.php.

References $s, $t, $title, drawCategoryBrowser(), ContextSource\getConfig(), ContextSource\getOutput(), getTitle(), ContextSource\msg(), and NS_CATEGORY.

Referenced by getCategories().

◆ getCopyright()

Skin::getCopyright ( $type = 'detect' )

Parameters

string $type

Returns: string

Definition at line 930 of file Skin.php.

References $title, $type, ContextSource\getConfig(), ContextSource\getOutput(), getTitle(), isRevisionCurrent(), Linker\makeExternalLink(), and ContextSource\msg().

◆ getCopyrightIcon()

Skin::getCopyrightIcon ( )

protected

Returns: null|string

Definition at line 973 of file Skin.php.

References ContextSource\getConfig().

◆ getDefaultModules()

Skin::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.

Any modules defined with the 'styles' key will be added as render blocking CSS via Output::addModuleStyles. Similarly, each key should refer to a list of modules

Stability: stable: to override

Returns: array Array of modules with helper keys for easy overriding

Definition at line 249 of file Skin.php.

References $modules, getAuthority(), ContextSource\getOutput(), and ContextSource\getUser().

◆ getFooterLinks()

Skin::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

Access: internal

Returns: array

Definition at line 2638 of file Skin.php.

◆ getHtmlElementAttributes()

Skin::getHtmlElementAttributes ( )

Return values for <html> element.

Returns: array Array of associative name-to-value elements for <html> element

Definition at line 558 of file Skin.php.

References $lang, and ContextSource\getLanguage().

Referenced by OutputPage\headElement().

◆ getIndicatorsData()

Skin::getIndicatorsData ( $indicators )

protected

Return an array of indicator data.

Can be used by subclasses but should not be extended.

Parameters

array $indicators return value of OutputPage::getIndicators

Returns: array

Definition at line 2233 of file Skin.php.

References $content.

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

◆ getIndicatorsHTML()

Skin::getIndicatorsHTML ( $indicators )

final

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.

Your skin may implement this differently, for example by handling some indicator names specially with a different UI. However, it is recommended to use a <div class="mw-indicator" id="mw-indicator-<id>" /> as a wrapper element for each indicator, for better compatibility with extensions and user scripts.

The raw data is available in ‘$this->data['indicators’]` as an associative array (keys: identifiers, values: contents) internally ordered by keys.

Since: 1.35

Deprecated:: since 1.36.

Parameters

array $indicators

Returns: string HTML

Definition at line 2209 of file Skin.php.

References getIndicatorsData(), and wfDeprecated().

◆ getLanguages()

Skin::getLanguages ( )

Generates array of language links for the current page.

This may includes items added to this section by the SidebarBeforeOutput hook (which may not necessarily be language links)

Since: 1.35

Returns: array

Definition at line 1459 of file Skin.php.

References ContextSource\getConfig(), ContextSource\getLanguage(), ContextSource\getOutput(), getTitle(), mapInterwikiToLanguage(), and ContextSource\msg().

Referenced by buildSidebar().

◆ getLogo()

Skin::getLogo ( )

protected

URL to the default square logo (1x key)

Deprecated:: since 1.36, please use ResourceLoaderSkinModule::getAvailableLogos

Returns: string

Definition at line 573 of file Skin.php.

References ResourceLoaderSkinModule\getAvailableLogos(), ContextSource\getConfig(), and wfDeprecated().

◆ getNewtalks()

Skin::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)

Returns: string

Definition at line 1900 of file Skin.php.

References $revStore, ContextSource\getOutput(), ContextSource\getUser(), and ContextSource\msg().

Referenced by SkinMustache\getTemplateData().

◆ getPageClasses()

Skin::getPageClasses ( $title )

TODO: document.

Parameters

Title $title

Returns: string

Definition at line 523 of file Skin.php.

References $title, $type, and getAuthority().

Referenced by OutputPage\headElement().

◆ getPersonalToolsForMakeListItem()

Skin::getPersonalToolsForMakeListItem ( $urls )

final

Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate.

The resulting array is built according to a format intended to be passed through makeListItem to generate the html. This is in reality the same list as already stored in personal_urls however it is reformatted so that you can just pass the individual items to makeListItem instead of hardcoding the element creation boilerplate.

Since: 1.35

Parameters

array $urls

Returns: array

Definition at line 2257 of file Skin.php.

Referenced by SkinMustache\getPortletsTemplateData().

◆ getPoweredBy()

Skin::getPoweredBy ( )

protected

Gets the powered by MediaWiki icon.

Returns: string

Definition at line 1003 of file Skin.php.

References ContextSource\getConfig().

◆ getRelevantTitle()

Skin::getRelevantTitle ( )

Return the "relevant" title.

A "relevant" title is not necessarily the actual title of the page. Special pages like Special:MovePage use set the page they are acting on as their "relevant" title, this allows the skin system to display things such as content tabs which belong to that page instead of displaying a basic special page tab which has almost no meaning.

Returns: Title

Definition at line 416 of file Skin.php.

References getTitle().

Referenced by getRelevantUser(), and preloadExistence().

◆ getRelevantUser()

Skin::getRelevantUser ( )

Return the "relevant" user.

A "relevant" user is similar to a relevant title. Special pages like Special:Contributions mark the user which they are relevant to so that things like the toolbox can display the information they usually are only able to display on a user's userpage and talkpage.

Returns: User|null Null if there's no relevant user or the viewer cannot view it.

Definition at line 437 of file Skin.php.

References $title, getRelevantTitle(), User\isIP(), User\newFromName(), and NS_USER.

Referenced by buildNavUrls().

◆ getRevisionId()

Skin::getRevisionId ( )

Get the current revision ID.

Deprecated:: since 1.34, use OutputPage::getRevisionId instead

Returns: int

Definition at line 380 of file Skin.php.

References ContextSource\getOutput(), and wfDeprecated().

◆ getSearchLink()

Skin::getSearchLink ( )

protected

Deprecated:: since 1.36.

Returns: string

Definition at line 919 of file Skin.php.

References getSearchPageTitle(), and wfDeprecated().

◆ getSearchPageTitle()

Skin::getSearchPageTitle ( )

Definition at line 2676 of file Skin.php.

Referenced by getSearchLink().

◆ getSiteFooterLinks()

Skin::getSiteFooterLinks ( )

Gets the link to the wiki's privacy policy, about page, and disclaimer page.

Access: internal: For use by SkinTemplate

Returns: string[] Map of (key => HTML) for 'privacy', 'about', 'disclaimer'

Definition at line 1180 of file Skin.php.

References footerLink(), and ContextSource\getConfig().

◆ getSiteNotice()

Skin::getSiteNotice ( )

Returns: string HTML fragment

Definition at line 2054 of file Skin.php.

References getCachedNotice(), and ContextSource\getUser().

Referenced by SkinMustache\getTemplateData().

◆ getSkinName()

Skin::getSkinName ( )

Returns: string|null Skin name

Definition at line 191 of file Skin.php.

Referenced by OutputPage\headElement().

◆ getSkinNames()

static Skin::getSkinNames ( )

static

Fetch the set of available skins.

Deprecated:: since 1.36. Use SkinFactory::getSkinNames() instead.

Returns: array Associative array of strings

Definition at line 89 of file Skin.php.

References wfDeprecated().

◆ getSkinStylePath()

Skin::getSkinStylePath ( $name )

Return a fully resolved style path URL to images or styles stored in the current skin's folder.

This method returns a URL resolved using the configured skin style path.

Requires $stylename to be set, otherwise throws MWException.

Deprecated:: since 1.36, Replace usages with direct path of the resource and then remove the $stylename property.

Parameters

string $name The name or path of a skin resource file

Returns: string The fully resolved style path URL

Exceptions

MWException

Definition at line 1292 of file Skin.php.

References ContextSource\getConfig().

◆ getUndeleteLink()

Skin::getUndeleteLink ( )

Returns: string HTML

Definition at line 795 of file Skin.php.

References $title, getAuthority(), getContext(), ContextSource\getLanguage(), ContextSource\getRequest(), getTitle(), SpecialPage\getTitleFor(), and ContextSource\msg().

◆ getVersion()

static Skin::getVersion ( )

static

Get the current major version of Skin.

This is used to manage changes to underlying data and for providing support for older and new versions of code.

Since: 1.36

Returns: int

Definition at line 79 of file Skin.php.

◆ initPage()

Skin::initPage ( OutputPage $out )

Stability: stable: to override

Parameters

OutputPage $out

Reimplemented in SkinFallback.

Definition at line 212 of file Skin.php.

References OutputPage\addMeta(), ContextSource\getConfig(), OutputPage\getHTMLTitle(), isResponsive(), and preloadExistence().

Referenced by SkinTemplate\outputPage().

◆ isResponsive()

Skin::isResponsive ( )

Indicates if this skin is responsive.

Responsive skins have skin–responsive added to <body> by OutputPage, and a viewport <meta> tag set by Skin::initPage.

Since: 1.36

Stability: stable: to override

Returns: bool

Definition at line 204 of file Skin.php.

Referenced by OutputPage\headElement(), and initPage().

◆ isRevisionCurrent()

Skin::isRevisionCurrent ( )

Whether the revision displayed is the latest revision of the page.

Deprecated:: since 1.34, use OutputPage::isRevisionCurrent instead

Returns: bool

Definition at line 392 of file Skin.php.

References ContextSource\getOutput(), and wfDeprecated().

Referenced by getCopyright().

◆ lastModified()

Skin::lastModified ( )

protected

Get the timestamp of the latest revision, formatted in user language.

Returns: string

Definition at line 1026 of file Skin.php.

References $s, $t, ContextSource\getLanguage(), ContextSource\getOutput(), ContextSource\getUser(), and ContextSource\msg().

◆ logoText()

Skin::logoText ( $align = '' )

Parameters

string $align

Returns: string

Definition at line 1060 of file Skin.php.

References ResourceLoaderSkinModule\getAvailableLogos(), ContextSource\getConfig(), and ContextSource\msg().

◆ mainPageLink()

Skin::mainPageLink ( )

Gets the link to the wiki's main page.

Deprecated:: since 1.36

Returns: string

Definition at line 1112 of file Skin.php.

References $s, ContextSource\msg(), and wfDeprecated().

◆ makeFooterIcon()

Skin::makeFooterIcon	(	$icon,
		$withImage = `'withImage'`
	)

Renders a $wgFooterIcons icon according to the method's arguments.

Parameters

array	$icon	The icon to build the html for, see $wgFooterIcons for the format of this array.
bool \| string	$withImage	Whether to use the icon's image or output a text-only footericon.

Returns: string HTML

Definition at line 1083 of file Skin.php.

References ContextSource\getConfig().

◆ makeInternalOrExternalUrl()

static Skin::makeInternalOrExternalUrl ( $name )

static

If url string starts with http, consider as external URL, else internal.

Parameters

string $name

Returns: string URL

Definition at line 1365 of file Skin.php.

References $title, and wfUrlProtocols().

◆ makeKnownUrlDetails()

static Skin::makeKnownUrlDetails	(	$name,
		$urlaction = `''`
	)

staticprotected

Make URL details where the article exists (or at least it's convenient to think so)

Parameters

string	$name	Article name
string \| array	$urlaction

Returns: array

Definition at line 1413 of file Skin.php.

References $title, and true.

◆ makeLink()

Skin::makeLink	(	$key,
		$item,
		$options = `[]`
	)

final

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...

Since: 1.35

Parameters

string	$key	Usually a key from the list you are generating this link from.
array	$item	Contains some of a specific set of keys.

The text of the link will be generated either from the contents of the "text" key in the $item array, if a "msg" key is present a message by that name will be used, and if neither of those are set the $key will be used as a message name.

If a "href" key is not present makeLink will just output htmlescaped text. The "href", "id", "class", "rel", and "type" keys are used as attributes for the link if present.

If an "id" or "single-id" (if you don't want the actual id to be output on the link) is present it will be used to generate a tooltip and accesskey for the link.

The keys "context" and "primary" are ignored; these keys are used internally by skins and are not supposed to be included in the HTML output.

If you don't want an accesskey, set $item['tooltiponly'] = true;

If a "data" key is present, it must be an array, where the keys represent the data-xxx properties with their provided values. For example, $item['data'] = [ 'foo' => 1, 'bar' => 'baz', ]; will render as element properties: data-foo='1' data-bar='baz'

The "class" key currently accepts both a string and an array of classes, but this will be changed to only accept an array in the future.

Parameters

array

$options

Can be used to affect the output of a link. Possible options are:

'text-wrapper' key to specify a list of elements to wrap the text of a link in. This should be an array of arrays containing a 'tag' and optionally an 'attributes' key. If you only have one element you don't need to wrap it in another array. eg: To use ... in all links use [ 'text-wrapper' => [ 'tag' => 'span' ] ] for your options.
'link-class' key can be used to specify additional classes to apply to all links.
'link-fallback' can be used to specify a tag to use instead of "<a>" if there is no link. eg: If you specify 'link-fallback' => 'span' than any non-link will output a "<span>" instead of just text.

Returns: string

Definition at line 2353 of file Skin.php.

References $title, ContextSource\msg(), Linker\titleAttrib(), and Linker\tooltipAndAccesskeyAttribs().

Referenced by makeListItem().

◆ makeListItem()

Skin::makeListItem	(	$key,
		$item,
		$options = `[]`
	)

final

Generates a list item for a navigation, portlet, portal, sidebar... list.

Since: 1.35

Parameters

string	$key	Usually a key from the list you are generating this link from.
array	$item	Array of list item data containing some of a specific set of keys. The "id", "class" and "itemtitle" keys will be used as attributes for the list item, if "active" contains a value of true a "active" class will also be appended to class. The "class" key currently accepts both a string and an array of classes, but this will be changed to only accept an array in the future.
array	$options

If you want something other than a "<li>" you can pass a tag name such as "tag" => "span" in the $options array to change the tag used. link/content data for the list item may come in one of two forms A "links" key may be used, in which case it should contain an array with a list of links to include inside the list item, see makeLink for the format of individual links array items.

Otherwise the relevant keys from the list item $item array will be passed to makeLink instead. Note however that "id" and "class" are used by the list item directly so they will not be passed to makeLink (however the link will still support a tooltip and accesskey from it) If you need an id or class on a single link you should include a "links" array with just one link item inside of it. You can also set "link-class" in $item to set a class on the link itself. If you want to add a title to the list item itself, you can set "itemtitle" to the value. $options is also passed on to makeLink calls

Returns: string

Definition at line 2469 of file Skin.php.

References makeLink().

Referenced by SkinMustache\getPortletData().

◆ makeMainPageUrl()

static Skin::makeMainPageUrl ( $urlaction = '' )

static

Parameters

string | array $urlaction

Returns: string

Definition at line 1307 of file Skin.php.

References $title.

◆ makeNSUrl()

static Skin::makeNSUrl	(	$name,
		$urlaction = `''`,
		$namespace = `NS_MAIN`
	)

static

this can be passed the NS number as defined in Language.php

Parameters

string	$name
string \| array	$urlaction
int	$namespace

Returns: string

Deprecated:: since 1.35, no longer used

Definition at line 1383 of file Skin.php.

References $title, and wfDeprecated().

◆ makeSearchButton()

Skin::makeSearchButton	(	$mode,
		$attrs = `[]`
	)

final

Parameters

string	$mode	representing the type of button wanted either `go`, `fulltext` or `image`
array	$attrs	(optional)

Exceptions

MWException if bad value of $mode passed in

Returns: string of HTML button

Definition at line 2554 of file Skin.php.

References ContextSource\msg(), and Linker\tooltipAndAccesskeyAttribs().

◆ makeSearchInput()

Skin::makeSearchInput ( $attrs = [] )

final

Since: 1.35

Parameters

array $attrs (optional) will be passed to tooltipAndAccesskeyAttribs and decorate the resulting input

Returns: string of HTML input

Definition at line 2532 of file Skin.php.

References ContextSource\getConfig(), ContextSource\msg(), and Linker\tooltipAndAccesskeyAttribs().

◆ makeSpecialUrl()

static Skin::makeSpecialUrl	(	$name,
		$urlaction = `''`,
		$proto = `null`
	)

static

Make a URL for a Special Page using the given query and protocol.

If $proto is set to null, make a local URL. Otherwise, make a full URL with the protocol specified.

Parameters

string	$name	Name of the Special page
string \| array	$urlaction	Query to append
string \| null	$proto	Protocol to use or null for a local URL

Returns: string

Definition at line 1325 of file Skin.php.

References $title, and SpecialPage\getSafeTitleFor().

◆ makeSpecialUrlSubpage()

static Skin::makeSpecialUrlSubpage	(	$name,
		$subpage,
		$urlaction = `''`
	)

static

Parameters

string	$name
string	$subpage
string \| array	$urlaction

Returns: string

Definition at line 1340 of file Skin.php.

References $title, and SpecialPage\getSafeTitleFor().

◆ makeToolbox()

Skin::makeToolbox	(	$navUrls,
		$feedUrls
	)

Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate.

The resulting array is built according to a format intended to be passed through makeListItem to generate the html.

Parameters

array	$navUrls
array	$feedUrls

Returns: array

Definition at line 2143 of file Skin.php.

Referenced by buildSidebar().

◆ makeUrl()

static Skin::makeUrl	(	$name,
		$urlaction = `''`
	)

static

Parameters

string	$name
string \| array	$urlaction

Returns: string

Deprecated:: since 1.36. Use Title methods directly.

Definition at line 1351 of file Skin.php.

References $title, and wfDeprecated().

◆ makeUrlDetails()

static Skin::makeUrlDetails	(	$name,
		$urlaction = `''`
	)

staticprotected

these return an array with the 'href' and boolean 'exists'

Parameters

string	$name
string \| array	$urlaction

Returns: array

Definition at line 1397 of file Skin.php.

References $title.

◆ makeVariablesScript()

static Skin::makeVariablesScript	(	$data,
		$nonce = `null`
	)

static

Deprecated:: since 1.36. Use ResourceLoader::makeInlineScript() directly.

Parameters

array	$data
string \| null	$nonce	OutputPage->getCSP()->getNonce()

Returns: string|WrappedString HTML

Definition at line 480 of file Skin.php.

References ResourceLoader\makeConfigSetScript(), ResourceLoader\makeInlineScript(), and wfDeprecated().

◆ mapInterwikiToLanguage()

Skin::mapInterwikiToLanguage ( $code )

Allows correcting the language of interlanguage links which, mostly due to legacy reasons, do not always match the standards compliant language tag.

Parameters

string $code

Returns: string

Since: 1.35

Definition at line 1446 of file Skin.php.

References ContextSource\getConfig().

Referenced by getLanguages().

◆ normalizeKey()

static Skin::normalizeKey ( $key )

static

Normalize a skin preference value to a form that can be loaded.

If a skin can't be found, it will fall back to the configured default ($wgDefaultSkin), or the hardcoded default ($wgFallbackSkin) if the default skin is unavailable too.

Parameters

string $key 'monobook', 'vector', etc.

Returns: string

Definition at line 121 of file Skin.php.

References $fallback, $wgDefaultSkin, and $wgFallbackSkin.

◆ outputPage()

Skin::outputPage ( )

abstract

Outputs the HTML generated by other functions.

Reimplemented in SkinTemplate.

◆ preloadExistence()

Skin::preloadExistence ( )

protected

Preload the existence of three commonly-requested pages in a single query.

Definition at line 331 of file Skin.php.

References $title, footerLinkTitle(), ContextSource\getConfig(), getRelevantTitle(), and ContextSource\getUser().

Referenced by initPage().

◆ prepareSubtitle()

Skin::prepareSubtitle ( )

final

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 2618 of file Skin.php.

Referenced by SkinMustache\getTemplateData().

◆ printSource()

Skin::printSource ( )

Text with the permalink to the source page, usually shown on the footer of a printed page.

Stability: stable: to override

Returns: string HTML text with an URL

Definition at line 776 of file Skin.php.

References $title, ContextSource\getOutput(), getTitle(), ContextSource\msg(), and wfExpandIRI().

Referenced by SkinMustache\getTemplateData().

◆ privacyLink()

Skin::privacyLink ( )

Gets the link to the wiki's privacy policy page.

Deprecated:: since 1.36, use self::footerLink();

Returns: string HTML

Definition at line 1217 of file Skin.php.

References footerLink(), and wfDeprecated().

◆ setRelevantTitle()

Skin::setRelevantTitle ( $t )

See also: self::getRelevantTitle()

Parameters

Title $t

Definition at line 402 of file Skin.php.

References $t.

◆ setRelevantUser()

Skin::setRelevantUser ( User $u )

See also: self::getRelevantUser()

Parameters

User $u

Definition at line 424 of file Skin.php.

◆ setSearchPageTitle()

Skin::setSearchPageTitle ( Title $title )

Definition at line 2680 of file Skin.php.

References $title.

◆ setupSkinUserCss()

Skin::setupSkinUserCss ( OutputPage $out )

Hook point for adding style modules to OutputPage.

Deprecated:: since 1.32 Use getDefaultModules() instead. If using for backwards compatability, the caller is required to throw deprecation warnings if this changes the number of style modules on OutputPage.

Parameters

OutputPage $out Legacy parameter, identical to $this->getOutput()

Definition at line 514 of file Skin.php.

References wfDeprecated().

Referenced by doSetupSkinUserCss().

◆ showEmailUser()

Skin::showEmailUser ( $id )

Parameters

User | int $id

Returns: bool

Definition at line 1266 of file Skin.php.

References ContextSource\getUser(), User\newFromId(), and SpecialEmailUser\validateTarget().

Referenced by buildNavUrls().

◆ subPageSubtitle()

Skin::subPageSubtitle ( $out )

Deprecated:: since 1.36 use Skin::prepareSubtitle instead

Parameters

OutputPage | null $out Defaults to $this->getOutput() if left as null (unused)

Returns: string

Definition at line 854 of file Skin.php.

References subPageSubtitleInternal(), and wfDeprecated().

◆ subPageSubtitleInternal()

Skin::subPageSubtitleInternal ( )

private

Returns: string

Definition at line 862 of file Skin.php.

References $lang, $title, ContextSource\getLanguage(), ContextSource\getOutput(), and ContextSource\msg().

Referenced by subPageSubtitle().

Member Data Documentation

◆ $mRelevantTitle

Skin::$mRelevantTitle = null

protected

Definition at line 54 of file Skin.php.

◆ $mRelevantUser

User null Skin::$mRelevantUser = null

protected

Definition at line 59 of file Skin.php.

◆ $options

array Skin::$options = []

protected

Skin options passed into constructor.

Definition at line 53 of file Skin.php.

◆ $searchPageTitle

Skin::$searchPageTitle = null

private

Definition at line 70 of file Skin.php.

◆ $skinname

string null Skin::$skinname = null

protected

Definition at line 48 of file Skin.php.

◆ $stylename

string Skin::$stylename = null

Stylesheets set to use.

Subdirectory in skins/ where various stylesheets are located. Only needs to be set if you intend to use the getSkinStylePath() method.

Definition at line 65 of file Skin.php.

◆ VERSION_MAJOR

const Skin::VERSION_MAJOR = 1

protected

The current major version of the skin specification.

Definition at line 68 of file Skin.php.

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

includes/skins/Skin.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ aboutLink()

◆ addToSidebar()

◆ addToSidebarPlain()

◆ afterContentHook()

◆ bottomScripts()

◆ buildFeedUrls()

◆ buildNavUrls()

◆ buildSidebar()

◆ checkTitle()

◆ disclaimerLink()

◆ doEditSectionLink()

◆ doSetupSkinUserCss()

◆ drawCategoryBrowser()

◆ editUrlOptions()

◆ footerLink()

◆ footerLinkTitle()

◆ generateDebugHTML()

◆ getAfterPortlet()

◆ getAllowedSkins()

◆ getCachedNotice()

◆ getCategories()

◆ getCategoryLinks()

◆ getCopyright()

◆ getCopyrightIcon()

◆ getDefaultModules()

◆ getFooterLinks()

◆ getHtmlElementAttributes()

◆ getIndicatorsData()

◆ getIndicatorsHTML()

◆ getLanguages()

◆ getLogo()

◆ getNewtalks()

◆ getPageClasses()

◆ getPersonalToolsForMakeListItem()

◆ getPoweredBy()

◆ getRelevantTitle()

◆ getRelevantUser()

◆ getRevisionId()

◆ getSearchLink()

◆ getSearchPageTitle()

◆ getSiteFooterLinks()

◆ getSiteNotice()

◆ getSkinName()

◆ getSkinNames()

◆ getSkinStylePath()

◆ getUndeleteLink()

◆ getVersion()

◆ initPage()

◆ isResponsive()

◆ isRevisionCurrent()

◆ lastModified()

◆ logoText()

◆ mainPageLink()

◆ makeFooterIcon()

◆ makeInternalOrExternalUrl()

◆ makeKnownUrlDetails()

◆ makeLink()

◆ makeListItem()

◆ makeMainPageUrl()

◆ makeNSUrl()

◆ makeSearchButton()

◆ makeSearchInput()

◆ makeSpecialUrl()

◆ makeSpecialUrlSubpage()

◆ makeToolbox()

◆ makeUrl()

◆ makeUrlDetails()

◆ makeVariablesScript()