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

Inheritance diagram for Skin:

Collaboration diagram for Skin:

Public Member Functions
	__call ($fname, $args)
	Use PHP's magic __call handler to intercept legacy calls to the linker for backwards compatibility.
	aboutLink ()
	Gets the link to the wiki's about page.
	addToBodyAttributes ($out, &$bodyAttrs)
	This will be called by OutputPage::headElement when it is creating the "<body>" tag, skins can override it if they have a need to add in any body attributes or classes of their own.
	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.
	commonPrintStylesheet ()
	This function previously controlled whether the 'mediawiki.legacy.wikiprintable' module should be loaded by OutputPage.
	disclaimerLink ()
	Gets the link to the wiki's general disclaimers page.
	doEditSectionLink (Title $nt, $section, $tooltip=null, $lang=false)
	Create a section edit link.
	drawCategoryBrowser ($tree)
	Render the array as a series of links.
	editUrlOptions ()
	Return URL options for the 'edit page' link.
	escapeSearchLink ()
	footerLink ($desc, $page)
	getCategories ()
	getCategoryLinks ()
	getCommonStylePath ($name)
	Return a fully resolved style path url to images or styles stored in the common folder.
	getCopyright ($type= 'detect')
	getCopyrightIcon ()
	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.
	getLogo ()
	URL to the logo.
	getNamespaceNotice ()
	Get a notice based on page's namespace.
	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.
	getPoweredBy ()
	Gets the powered by MediaWiki icon.
	getRelevantTitle ()
	Return the "relevant" title.
	getRelevantUser ()
	Return the "relevant" user.
	getRevisionId ()
	Get the current revision ID.
	getSearchLink ()
	getSiteNotice ()
	Get the site notice.
	getSkinName ()
	getSkinStylePath ($name)
	Return a fully resolved style path url to images or styles stored in the current skins's folder.
	getUndeleteLink ()
	initPage (OutputPage $out)
	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.
	outputPage (OutputPage $out=null)
	Outputs the HTML generated by other functions.
	preloadExistence ()
	Preload the existence of three commonly-requested pages in a single query.
	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)
	Set the "relevant" title.
	setRelevantUser ($u)
	Set the "relevant" user.
	setupSkinUserCss (OutputPage $out)
	Add skin specific stylesheets Calling this method with an $out of anything but the same OutputPage inside ->getOutput() is deprecated.
	showEmailUser ($id)
	showIPinHeader ()
	Returns true if the IP should be shown in the header.
	subPageSubtitle ()
Static Public Member Functions
static	checkTitle (&$title, $name)
	make sure we have some title to operate on
static	getDynamicStylesheetQuery ()
	Get the query to generate a dynamic stylesheet.
static	getSkinNameMessages ()
	Fetch the skinname messages for available skins.
static	getSkinNames ()
	Fetch the set of available skins.
static	getUsableSkins ()
	Fetch the list of user-selectable skins in regards to $wgSkipSkins.
static	makeGlobalVariablesScript ($unused)
	Make a "<script>" tag containing global variables.
static	makeI18nUrl ($name, $urlaction= '')
static	makeInternalOrExternalUrl ($name)
	If url string starts with http, consider as external URL, else internal.
static	makeKnownUrlDetails ($name, $urlaction= '')
	Make URL details where the article exists (or at least it's convenient to think so)
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	makeUrlDetails ($name, $urlaction= '')
	these return an array with the 'href' and boolean 'exists'
static	makeVariablesScript ($data)
static &	newFromKey ($key)
	Factory method for loading a skin of a given type.
static	normalizeKey ($key)
	Normalize a skin preference value to a form that can be loaded.
Protected Member Functions
	afterContentHook ()
	This runs a hook to allow extensions placing their stuff after content and article metadata (e.g.
	generateDebugHTML ()
	Generate debug data HTML for displaying at the bottom of the main content area.
	lastModified ()
	Get the timestamp of the latest revision, formatted in user language.
Protected Attributes
	$mRelevantTitle = null
	$mRelevantUser = null
	$skinname = 'standard'
Private Member Functions
	getCachedNotice ($name)
	Get a cached notice.

Detailed Description

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

This base class is also the "Standard" skin.

See docs/skin.txt for more information.

Definition at line 35 of file Skin.php.

Member Function Documentation

Skin::__call	(	$	fname,
		$	args
	)

Use PHP's magic __call handler to intercept legacy calls to the linker for backwards compatibility.

Parameters:

string	$fname	Name of called method
array	$args	Arguments to the method

Exceptions:

MWException

Returns:: mixed

Definition at line 1612 of file Skin.php.

References $fname, array(), and wfDeprecated().

Skin::aboutLink ( )

Gets the link to the wiki's about page.

Returns:: String HTML

Definition at line 984 of file Skin.php.

References footerLink().

Referenced by SkinTemplate\outputPage().

Skin::addToBodyAttributes	(	$	out,
		&$	bodyAttrs
	)

This will be called by OutputPage::headElement when it is creating the "<body>" tag, skins can override it if they have a need to add in any body attributes or classes of their own.

Parameters:

$out	OutputPage
$bodyAttrs	Array

Reimplemented in SkinVector.

Definition at line 465 of file Skin.php.

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:

$bar	array
$message	String

Definition at line 1248 of file Skin.php.

References addToSidebarPlain(), and wfMessage().

Referenced by buildSidebar().

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

Add content from plain text.

Since:: 1.17

Parameters:

$bar	array
$text	string

Returns:: Array

Definition at line 1259 of file Skin.php.

References $lines, $link, $title, array(), as, Sanitizer\escapeId(), ContextSource\getTitle(), global, ContextSource\msg(), Title\newFromText(), MessageCache\singleton(), wfMatchesDomainList(), and wfUrlProtocols().

Referenced by addToSidebar().

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

References array(), wfDebug(), and wfRunHooks().

Referenced by SkinTemplate\outputPage().

Skin::bottomScripts ( )

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

Returns:: String HTML-wrapped JS code to be put before "</body>"

Definition at line 639 of file Skin.php.

References array(), ContextSource\getOutput(), and wfRunHooks().

Referenced by SkinTemplate\outputPage().

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 array( 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' / ...)
- 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. It is either:
- HTML text (
  - ......
  )
- array of link data in a format accepted by BaseTemplate::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.

Returns:: array

Definition at line 1214 of file Skin.php.

References $key, $wgMemc, addToSidebar(), array(), ContextSource\getLanguage(), global, wfMemcKey(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by SkinTemplate\outputPage().

static Skin::checkTitle	(	&$	title,
		$	name
	)		`[static]`

make sure we have some title to operate on

Parameters:

$title	Title
$name	string

Definition at line 1184 of file Skin.php.

References $name, $title, and Title\newFromText().

Referenced by SkinTemplate\makeArticleUrlDetails(), makeI18nUrl(), makeKnownUrlDetails(), makeMainPageUrl(), makeNSUrl(), SkinTemplate\makeTalkUrlDetails(), makeUrl(), and makeUrlDetails().

Skin::commonPrintStylesheet ( )

This function previously controlled whether the 'mediawiki.legacy.wikiprintable' module should be loaded by OutputPage.

That module no longer exists and the return value of this method is ignored.

If your skin doesn't provide its own print styles, the 'mediawiki.legacy.commonPrint' module can be used instead (SkinTemplate-based skins do it automatically).

Deprecated:: since 1.22

Returns:: bool

Definition at line 1355 of file Skin.php.

References wfDeprecated().

Skin::disclaimerLink ( )

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

Returns:: String HTML

Definition at line 992 of file Skin.php.

References footerLink().

Referenced by SkinTemplate\outputPage().

Skin::doEditSectionLink	(	Title $	nt,
		$	section,
		$	tooltip = `null`,
		$	lang = `false`
	)

Create a section edit link.

This supersedes editSectionLink() and editSectionLinkForOther().

Parameters:

	$nt	Title The title being linked to (may not be the same as $wgTitle, 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	$tooltip	The tooltip to use for the link: will be escaped and wrapped in the 'editsectionhint' message
	$lang	string Language code

Returns:: string HTML to use for edit link

Definition at line 1573 of file Skin.php.

References $attribs, $link, $result, $section, array(), Sanitizer\decodeCharReferences(), Linker\link(), text, wfGetLangObj(), wfMessage(), and wfRunHooks().

Skin::drawCategoryBrowser ( $ tree )

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

References as, empty, Linker\link(), and Title\newFromText().

Referenced by getCategoryLinks().

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

Definition at line 1003 of file Skin.php.

References $options, array(), getRevisionId(), and isRevisionCurrent().

Skin::escapeSearchLink ( )

Returns:: string

Definition at line 767 of file Skin.php.

References getSearchLink().

Referenced by SkinTemplate\outputPage().

Skin::footerLink	(	$	desc,
		$	page
	)

Parameters:

$desc
$page

Returns:: string

Definition at line 954 of file Skin.php.

References $title, Linker\linkKnown(), ContextSource\msg(), Title\newFromText(), and text.

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

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

Definition at line 630 of file Skin.php.

References MWDebug\getHTMLDebugLog().

Referenced by SkinTemplate\outputPage().

Skin::getCachedNotice ( $ name ) [private]

Get a cached notice.

Parameters:

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

Returns:: String: HTML fragment

Definition at line 1461 of file Skin.php.

References $key, $name, $parserMemc, $wgContLang, array(), empty, ContextSource\getOutput(), global, ContextSource\msg(), Html\rawElement(), wfMemcKey(), wfProfileIn(), and wfProfileOut().

Referenced by getNamespaceNotice(), and getSiteNotice().

Skin::getCategories ( )

Returns:: string

Definition at line 571 of file Skin.php.

References $out, empty, getCategoryLinks(), ContextSource\getOutput(), ContextSource\getTitle(), and ContextSource\getUser().

Referenced by SkinTemplate\outputPage().

Skin::getCategoryLinks ( )

Returns:: string

Definition at line 481 of file Skin.php.

References $out, $s, $t, drawCategoryBrowser(), empty, ContextSource\getOutput(), ContextSource\getTitle(), ContextSource\getUser(), global, Linker\link(), ContextSource\msg(), Title\newFromText(), and wfMessage().

Referenced by getCategories().

Skin::getCommonStylePath ( $ name )

Return a fully resolved style path url to images or styles stored in the common folder.

This method returns a url resolved using the configured skin style path and includes the style version inside of the url.

Parameters:

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

Returns:: String The fully resolved style path url including styleversion

Definition at line 1034 of file Skin.php.

References global.

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

Parameters:

$type string

Returns:: string

Definition at line 775 of file Skin.php.

References $link, $title, $wgContLang, array(), ContextSource\getLanguage(), ContextSource\getTitle(), global, isRevisionCurrent(), Linker\linkKnown(), Linker\makeExternalLink(), ContextSource\msg(), Title\newFromText(), Html\rawElement(), and wfRunHooks().

Referenced by SkinTemplate\outputPage().

Skin::getCopyrightIcon ( )

Returns:: null|string

Definition at line 824 of file Skin.php.

References $out, and global.

Referenced by SkinTemplate\outputPage().

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.

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

Definition at line 207 of file Skin.php.

References $out, $user, array(), ContextSource\getOutput(), and global.

static Skin::getDynamicStylesheetQuery ( ) [static]

Get the query to generate a dynamic stylesheet.

Returns:: array

Definition at line 408 of file Skin.php.

References array(), and global.

Skin::getLogo ( )

URL to the logo.

Returns:: String

Definition at line 473 of file Skin.php.

References global.

Referenced by logoText().

Skin::getNamespaceNotice ( )

Get a notice based on page's namespace.

Returns:: String: HTML fragment

Definition at line 1515 of file Skin.php.

References $key, getCachedNotice(), ContextSource\getTitle(), wfProfileIn(), and wfProfileOut().

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

References $newtalks, $out, $user, array(), as, Xml\element(), ContextSource\getOutput(), ContextSource\getUser(), Linker\linkKnown(), ContextSource\msg(), Revision\newFromTitle(), params, IDBAccessObject\READ_NORMAL, wfRunHooks(), and wfWikiID().

Referenced by SkinTemplate\outputPage().

Skin::getPageClasses ( $ title )

TODO: document.

Parameters:

$title Title

Returns:: String

Definition at line 435 of file Skin.php.

References $name, $title, Sanitizer\escapeClass(), list, and SpecialPageFactory\resolveAlias().

Referenced by SkinTemplate\outputPage().

Skin::getPoweredBy ( )

Gets the powered by MediaWiki icon.

Returns:: string

Definition at line 854 of file Skin.php.

References array(), global, and wfRunHooks().

Referenced by SkinTemplate\outputPage().

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 to that page instead of displaying a basic special page tab which has almost no meaning.

Returns:: Title

Definition at line 324 of file Skin.php.

References ContextSource\getTitle().

Referenced by SkinTemplate\buildContentNavigationUrls(), and 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

Definition at line 348 of file Skin.php.

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

Referenced by SkinTemplate\buildNavUrls().

Skin::getRevisionId ( )

Get the current revision ID.

Returns:: Integer

Definition at line 291 of file Skin.php.

References ContextSource\getOutput().

Referenced by SkinTemplate\buildNavUrls(), editUrlOptions(), isRevisionCurrent(), lastModified(), and printSource().

Skin::getSearchLink ( )

Returns:: String

Definition at line 759 of file Skin.php.

References $searchPage, and SpecialPage\getTitleFor().

Referenced by escapeSearchLink().

Skin::getSiteNotice ( )

Get the site notice.

Returns:: String: HTML fragment

Definition at line 1535 of file Skin.php.

References $siteNotice, array(), getCachedNotice(), ContextSource\getUser(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by SkinTemplate\outputPage().

Skin::getSkinName ( )

Returns:: string skin name

Definition at line 186 of file Skin.php.

Referenced by SkinTemplate\outputPage().

static Skin::getSkinNameMessages ( ) [static]

Fetch the skinname messages for available skins.

Returns:: array of strings

Definition at line 82 of file Skin.php.

References $messages, array(), and as.

static Skin::getSkinNames ( ) [static]

Fetch the set of available skins.

Returns:: array associative array of strings

Definition at line 44 of file Skin.php.

References $file, $matches, $wgValidSkinNames, array(), global, wfProfileIn(), and wfProfileOut().

Referenced by ResourceLoaderContext\__construct(), ApiQuerySiteinfo\appendSkins(), ResourceLoaderStartUpModule\getConfig(), getUsableSkins(), newFromKey(), and normalizeKey().

Skin::getSkinStylePath ( $ name )

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

This method returns a url resolved using the configured skin style path and includes the style version inside of the url.

Parameters:

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

Returns:: String The fully resolved style path url including styleversion

Definition at line 1046 of file Skin.php.

References global.

Skin::getUndeleteLink ( )

Returns:: String

Definition at line 669 of file Skin.php.

References $n, ContextSource\getRequest(), ContextSource\getTitle(), SpecialPage\getTitleFor(), ContextSource\getUser(), Linker\linkKnown(), and ContextSource\msg().

Referenced by SkinTemplate\outputPage().

static Skin::getUsableSkins ( ) [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.

Returns:: array of strings

Definition at line 97 of file Skin.php.

References as, getSkinNames(), and global.

Referenced by ApiQuerySiteinfo\appendSkins(), and Preferences\generateSkinOptions().

Skin::initPage ( OutputPage $ out )

Parameters:

$out	OutputPage

Reimplemented in SkinVector.

Definition at line 193 of file Skin.php.

References preloadExistence(), wfProfileIn(), and wfProfileOut().

Referenced by SkinTemplate\outputPage().

Skin::isRevisionCurrent ( )

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

Returns:: Boolean

Definition at line 300 of file Skin.php.

References getRevisionId(), and ContextSource\getTitle().

Referenced by SkinTemplate\buildContentNavigationUrls(), editUrlOptions(), getCopyright(), and SkinTemplate\outputPage().

Skin::lastModified ( ) [protected]

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

Returns:: String

Definition at line 868 of file Skin.php.

References $s, $t, $timestamp, ContextSource\getLanguage(), ContextSource\getOutput(), getRevisionId(), Revision\getTimestampFromId(), ContextSource\getTitle(), ContextSource\getUser(), ContextSource\msg(), and wfGetLB().

Referenced by SkinTemplate\outputPage().

Skin::logoText ( $ align = '' )

Parameters:

$align string

Returns:: string

Definition at line 895 of file Skin.php.

References $s, getLogo(), ContextSource\msg(), and Title\newMainPage().

Referenced by SkinTemplate\outputPage().

Skin::mainPageLink ( )

Gets the link to the wiki's main page.

Returns:: string

Definition at line 940 of file Skin.php.

References $s, Linker\linkKnown(), ContextSource\msg(), and Title\newMainPage().

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

References $html, array(), Html\element(), and Html\rawElement().

static Skin::makeGlobalVariablesScript ( $ unused ) [static]

Make a "<script>" tag containing global variables.

Deprecated:: in 1.19

Parameters:

$unused

Returns:: string HTML fragment

Definition at line 395 of file Skin.php.

References $wgOut, global, makeVariablesScript(), and wfDeprecated().

static Skin::makeI18nUrl	(	$	name,
		$	urlaction = `''`
	)		`[static]`

Parameters:

$name	string
$urlaction	string

Returns:: String

Definition at line 1100 of file Skin.php.

References $name, $title, checkTitle(), Title\newFromText(), text, and wfMessage().

static Skin::makeInternalOrExternalUrl ( $ name ) [static]

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

Parameters:

$name String

Returns:: String URL

Definition at line 1124 of file Skin.php.

References $name, makeUrl(), and wfUrlProtocols().

Referenced by UserloginTemplate\execute(), and CologneBlueTemplate\sysLinks().

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

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

Parameters:

string	$name	Article name
	$urlaction	String

Returns:: Array

Definition at line 1168 of file Skin.php.

References $name, $title, array(), checkTitle(), Title\newFromText(), and true.

Referenced by SkinTemplate\setupTemplateForOutput().

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

Parameters:

$urlaction string

Returns:: String

Definition at line 1057 of file Skin.php.

References $title, checkTitle(), and Title\newMainPage().

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

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

Parameters:

$name
$urlaction	string
$namespace	int

Returns:: String

Definition at line 1139 of file Skin.php.

References $name, $title, checkTitle(), and Title\makeTitleSafe().

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	$urlaction	Query to append
	$proto	Protocol to use or null for a local URL

Returns:: String

Definition at line 1075 of file Skin.php.

References $name, $title, and SpecialPage\getSafeTitleFor().

Referenced by SkinTemplate\buildPersonalUrls().

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

Parameters:

$name	string
$subpage	string
$urlaction	string

Returns:: String

Definition at line 1090 of file Skin.php.

References $name, $title, and SpecialPage\getSafeTitleFor().

Referenced by SkinTemplate\buildPersonalUrls().

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

Parameters:

$name	string
$urlaction	string

Returns:: String

Definition at line 1111 of file Skin.php.

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

Referenced by makeInternalOrExternalUrl().

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

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

Parameters:

$name
$urlaction	string

Returns:: array

Definition at line 1152 of file Skin.php.

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

Referenced by SkinTemplate\setupTemplateForOutput().

static Skin::makeVariablesScript ( $ data ) [static]

Parameters:

$data array

Returns:: string

Definition at line 378 of file Skin.php.

References Html\inlineScript(), ResourceLoader\makeConfigSetScript(), and ResourceLoader\makeLoaderConditionalScript().

Referenced by makeGlobalVariablesScript().

static& Skin::newFromKey ( $ key ) [static]

Factory method for loading a skin of a given type.

Parameters:

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

Returns:: Skin

Definition at line 156 of file Skin.php.

References $key, $skin, getSkinNames(), global, normalizeKey(), and wfDebug().

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 (or the old 'Classic' skin if that's broken).

Parameters:

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

Returns:: string

Definition at line 116 of file Skin.php.

References $fallback, $key, array(), getSkinNames(), and global.

Referenced by ApiQuerySiteinfo\appendSkins(), and newFromKey().

Skin::outputPage ( OutputPage $ out = null ) [abstract]

Outputs the HTML generated by other functions.

Parameters:

$out	OutputPage

Reimplemented in SkinTemplate.

Skin::preloadExistence ( )

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

Definition at line 266 of file Skin.php.

References $lb, $titles, $user, array(), ContextSource\getTitle(), and ContextSource\getUser().

Referenced by initPage().

Skin::printSource ( )

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

Returns:: string HTML text with an URL

Definition at line 655 of file Skin.php.

References getRevisionId(), ContextSource\getTitle(), ContextSource\msg(), and wfExpandIRI().

Referenced by SkinTemplate\outputPage().

Skin::privacyLink ( )

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

Returns:: String HTML

Definition at line 976 of file Skin.php.

References footerLink().

Referenced by SkinTemplate\outputPage().

Skin::setRelevantTitle ( $ t )

Set the "relevant" title.

See also:: self::getRelevantTitle()

Parameters:

$t	Title object to use

Definition at line 310 of file Skin.php.

References $t.

Skin::setRelevantUser ( $ u )

Set the "relevant" user.

See also:: self::getRelevantUser()

Parameters:

$u	User object to use

Definition at line 336 of file Skin.php.

Skin::setupSkinUserCss ( OutputPage $ out ) [abstract]

Add skin specific stylesheets Calling this method with an $out of anything but the same OutputPage inside ->getOutput() is deprecated.

The $out arg is kept for compatibility purposes with skins.

Parameters:

$out	OutputPage

Todo:: delete

Reimplemented in SkinTemplate, SkinVector, SkinMonoBook, SkinCologneBlue, and SkinModern.

Skin::showEmailUser ( $ id )

Parameters:

$id User|int

Returns:: bool

Definition at line 1017 of file Skin.php.

References from, ContextSource\getUser(), User\newFromId(), and user.

Referenced by SkinTemplate\buildNavUrls().

Skin::showIPinHeader ( )

Returns true if the IP should be shown in the header.

Returns:: Bool

Definition at line 751 of file Skin.php.

References global.

Referenced by SkinTemplate\buildPersonalUrls(), and SkinTemplate\setupTemplateForOutput().

Skin::subPageSubtitle ( )

Returns:: string

Definition at line 697 of file Skin.php.

References $link, $out, $wgLang, array(), as, ContextSource\getOutput(), ContextSource\getTitle(), global, MWNamespace\hasSubpages(), Linker\linkKnown(), ContextSource\msg(), Title\newFromText(), and wfRunHooks().

Referenced by SkinTemplate\outputPage().

Member Data Documentation

Skin::$mRelevantTitle = null [protected]

Definition at line 37 of file Skin.php.

Skin::$mRelevantUser = null [protected]

Definition at line 38 of file Skin.php.

Skin::$skinname = 'standard' [protected]

Reimplemented in SkinTemplate, SkinMonoBook, SkinVector, SkinModern, and SkinCologneBlue.

Definition at line 36 of file Skin.php.

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

includes/Skin.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation