MediaWiki  master
Skin Class Reference

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

 __construct ( $options=null)
 
 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 ( $triggerWarnings=true)
 This gets called shortly before the "</body>" tag. More...
 
 buildSidebar ()
 Build an array that represents the sidebar(s), the navigation bar among them. More...
 
 doEditSectionLink (Title $nt, $section, $sectionTitle, 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...
 
 getFooterIcons ()
 Get template representation of the footer. More...
 
 getHtmlElementAttributes ()
 Return values for <html> element. 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...
 
 getOptions ()
 Returns skin options Recommended to use SkinFactory::getSkinOptions instead. More...
 
 getPageClasses ( $title)
 TODO: document. More...
 
 getPersonalToolsForMakeListItem ( $urls, $applyClassesToListItems=false)
 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...
 
 getSiteNotice ()
 
 getSkinName ()
 
 getTemplateData ()
 
 getUndeleteLink ()
 
 initPage (OutputPage $out)
 
 isResponsive ()
 Indicates if this skin is responsive. More...
 
 logoText ( $align='')
 
 makeFooterIcon ( $icon, $withImage='withImage')
 Renders a $wgFooterIcons icon according to the method's arguments. More...
 
 makeLink ( $key, $item, $linkOptions=[])
 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...
 
 outputPage ()
 Outputs the HTML generated by other functions. More...
 
 prepareSubtitle (bool $withContainer=true)
 Prepare the subtitle of the page for output in the skin if one has been set. More...
 
 printSource ()
 Text with the permalink to the source page, usually shown on the footer of a printed page. More...
 
 setRelevantTitle ( $t)
 
 setRelevantUser (?UserIdentity $u)
 
 showEmailUser ( $id)
 
 supportsMenu (string $menu)
 Does the skin support the named menu? More...
 
- 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...
 
 getActionName ()
 Get the action name for the current web request. More...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 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)
 

Static Public Member Functions

static getPortletLinkOptions (RL\Context $context)
 Returns skin options for portlet links, used by addPortletLink. More...
 
static getVersion ()
 Get the current major version of Skin. More...
 
static makeInternalOrExternalUrl ( $name)
 If url string starts with http, consider as external URL, else internal. More...
 
static makeMainPageUrl ( $urlaction='')
 
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 normalizeKey ( $key)
 Normalize a skin preference value to a form that can be loaded. More...
 

Protected Member Functions

 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...
 
 buildNavUrls ()
 Build array of common navigation links. More...
 
 getAction ()
 
 getComponent (string $name)
 
 getIndicatorsData ( $indicators)
 Return an array of indicator data. More...
 
 getJsConfigVars ()
 Returns array of config variables that should be added only to this skin for use in JavaScript. More...
 
 getPortletData (string $name, array $items)
 
 lastModified ()
 Get the timestamp of the latest revision, formatted in user language. More...
 
 prepareUndeleteLink ()
 Prepare undelete link for output in page. More...
 
 prepareUserLanguageAttributes ()
 Prepare user language attribute links. More...
 
 wrapHTML ( $title, $html)
 Wrap the body text with language information and identifiable element. More...
 

Static Protected Member Functions

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

 $mRelevantTitle = null
 
array $options = []
 Skin options passed into constructor. More...
 
string null $skinname = null
 
const VERSION_MAJOR = 1
 The current major version of the skin specification. More...
 

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

Constructor & Destructor Documentation

◆ __construct()

Skin::__construct (   $options = null)
Since
1.31
Parameters
string | array | null$optionsOptions 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: Internal skin name, generally in lowercase to comply with conventions for interface message keys and CSS class names which embed this value.
  • scripts: An array of ResourceLoader script modules.
  • styles: An array of ResourceLoader style modules to load on all pages.
  • responsive: Whether the skin supports responsive behaviour and wants a viewport meta tag to be added to the HTML head. Note, users can disable this feature via a user preference.
  • link: An array of link options that will be used in Skin::makeLink calls.
  • toc: Whether a table of contents is included in the main article content area. It defaults to true, but if your skins wants to place a table of contents elsewhere (for example, in a sidebar), set toc to false.

Definition at line 261 of file Skin.php.

Member Function Documentation

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

◆ addToSidebarPlain()

Skin::addToSidebarPlain ( $bar,
  $text 
)

Add content from plain text.

Since
1.17
Parameters
array&$bar
string$text
Returns
array

Definition at line 1522 of file Skin.php.

References $lines, $title, Sanitizer\escapeIdForAttribute(), getTitle(), Title\newFromText(), Title\newMainPage(), wfMatchesDomainList(), and wfUrlProtocols().

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

References wfDebug().

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

◆ bottomScripts()

Skin::bottomScripts (   $triggerWarnings = true)

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

Deprecated:
since 1.37
Parameters
bool$triggerWarningsintroduced in 1.39 whether to trigger deprecation notice.
Returns
string|WrappedStringList HTML containing scripts to put before </body>

Definition at line 733 of file Skin.php.

References wfDeprecated().

Referenced by SkinTemplate\prepareQuickTemplate().

◆ buildFeedUrls()

Skin::buildFeedUrls ( )
finalprotected

Build data structure representing syndication links.

Since
1.35
Returns
array

Definition at line 1413 of file Skin.php.

Referenced by SkinTemplate\prepareQuickTemplate().

◆ buildNavUrls()

Skin::buildNavUrls ( )
protected

Build array of common navigation links.

Assumes thispage property has been set before execution.

Since
1.35
Returns
array

Definition at line 1263 of file Skin.php.

References $title, getAuthority(), getContext(), getTitle(), SpecialPage\getTitleFor(), getUser(), UploadBase\isAllowed(), UploadBase\isEnabled(), NS_CATEGORY, and SpecialPage\setContext().

Referenced by SkinTemplate\prepareQuickTemplate().

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

Returns
array

Definition at line 1450 of file Skin.php.

Referenced by SkinTemplate\prepareQuickTemplate().

◆ doEditSectionLink()

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

Create a section edit link.

Parameters
Title$ntThe title being linked to (may not be the same as the current page, if the section is included from a template)
string$sectionThe designation of the section being pointed to, to be included in the link, like "&section=$section"
string$sectionTitleSection title. It is used in the link tooltip, escaped and wrapped in the 'editsectionhint' message
Language$lang
Returns
string HTML to use for edit link

Definition at line 1831 of file Skin.php.

References $lang, Html\closeElement(), Html\openElement(), and Html\rawElement().

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

◆ 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$descThe i18n message key for the link text. The content of this message will be the visible 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$pageThe 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 message 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
Deprecated:
since 1.40

Definition at line 995 of file Skin.php.

References $title, Html\element(), Title\newFromText(), and wfDeprecated().

◆ getAction()

Skin::getAction ( )
finalprotected
Returns
string
Deprecated:
since 1.39

Definition at line 2268 of file Skin.php.

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

◆ getCategories()

Skin::getCategories ( )
Returns
string HTML

Definition at line 671 of file Skin.php.

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

◆ getCategoryLinks()

Skin::getCategoryLinks ( )
Returns
string HTML

Reimplemented in SkinTemplate.

Definition at line 605 of file Skin.php.

References $s, $t, $title, getTitle(), Title\newFromText(), and Html\rawElement().

◆ getComponent()

Skin::getComponent ( string  $name)
finalprotected
Access: internal
use in Skin.php, SkinTemplate.php or SkinMustache.php
Parameters
string$name
Returns
SkinComponent

Definition at line 106 of file Skin.php.

Referenced by SkinTemplate\prepareQuickTemplate().

◆ getCopyright()

Skin::getCopyright (   $type = 'detect')
final
Parameters
string$type
Returns
string

Definition at line 906 of file Skin.php.

References $type, and wfDeprecated().

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

References $modules, getAuthority(), and getUser().

◆ getFooterIcons()

Skin::getFooterIcons ( )

Get template representation of the footer.

Stable to use since 1.40 but should not be overridden.

Since
1.35
Access: internal
for use inside SkinComponentRegistryContext
Returns
array

Definition at line 952 of file Skin.php.

References MWDebug\detectDeprecatedOverride().

Referenced by SkinTemplate\prepareQuickTemplate().

◆ getHtmlElementAttributes()

Skin::getHtmlElementAttributes ( )

Return values for <html> element.

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

Definition at line 593 of file Skin.php.

References $lang.

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$indicatorsreturn value of OutputPage::getIndicators
Returns
array

Definition at line 1942 of file Skin.php.

References $content, and Sanitizer\escapeIdForAttribute().

Referenced by SkinMustache\getTemplateData().

◆ getJsConfigVars()

Skin::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.38 or 1.35 if extending SkinTemplate.
Returns
array

Definition at line 2217 of file Skin.php.

Referenced by SkinTemplate\outputPage().

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

References LanguageCode\bcp47(), getTitle(), and Title\newFromText().

Referenced by SkinTemplate\prepareQuickTemplate().

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

References $revStore, WikiMap\getCurrentWikiId(), and getUser().

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

◆ getOptions()

Skin::getOptions ( )
final

Returns skin options Recommended to use SkinFactory::getSkinOptions instead.

Access: internal
Returns
array Skin options passed into constructor

Definition at line 2313 of file Skin.php.

Referenced by SkinTemplate\generateHTML(), and OutputPage\headElement().

◆ getPageClasses()

Skin::getPageClasses (   $title)

TODO: document.

Parameters
Title$title
Returns
string

Definition at line 556 of file Skin.php.

References $title, $type, Sanitizer\escapeClass(), and getAuthority().

Referenced by OutputPage\headElement().

◆ getPersonalToolsForMakeListItem()

Skin::getPersonalToolsForMakeListItem (   $urls,
  $applyClassesToListItems = false 
)
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
bool$applyClassesToListItems(optional) when set behaves consistently with other menus, applying the class property applies to list items. When not set will move the class to child links.
Returns
array[]

Definition at line 1968 of file Skin.php.

Referenced by SkinTemplate\getStructuredPersonalTools(), and SkinTemplate\makePersonalToolsList().

◆ getPortletData()

Skin::getPortletData ( string  $name,
array  $items 
)
finalprotected
Parameters
string$nameof the portal e.g. p-personal the name is personal.
array$itemsthat are accepted input to Skin::makeListItem
Returns
array data that can be passed to a Mustache template that represents a single menu.

Definition at line 2388 of file Skin.php.

◆ getPortletLinkOptions()

static Skin::getPortletLinkOptions ( RL\Context  $context)
static

Returns skin options for portlet links, used by addPortletLink.

Access: internal
Parameters
RL\\Context$context
Returns
array $linkOptions
  • '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. If text-wrapper contains multiple entries they are interpreted as going from the outer wrapper to the inner wrapper.

Definition at line 2367 of file Skin.php.

◆ 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|null the title is null when no relevant title was set, as this falls back to ContextSource::getTitle

Definition at line 491 of file Skin.php.

References getTitle().

◆ 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
UserIdentity|null Null if there's no relevant user or the viewer cannot view it.

Definition at line 512 of file Skin.php.

References $title, and NS_USER.

◆ getSiteNotice()

Skin::getSiteNotice ( )
Returns
string HTML fragment

Definition at line 1786 of file Skin.php.

References getUser(), and Html\rawElement().

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

◆ getSkinName()

Skin::getSkinName ( )
Returns
string|null Skin name

Definition at line 286 of file Skin.php.

Referenced by OutputPage\headElement().

◆ getTemplateData()

Skin::getTemplateData ( )
Stability: stable
to extend. Subclasses may extend this method to add additional template data.
Access: internal
this method should never be called outside Skin and its subclasses as it can be computationally expensive and typically has side effects on the Skin instance, through execution of hooks.

The data keys should be valid English words. Compound words should be hyphenated except if they are normally written as one word. Each key should be prefixed with a type hint, this may be enforced by the class PHPUnit test.

Plain strings are prefixed with 'html-', plain arrays with 'array-' and complex array data with 'data-'. 'is-' and 'has-' prefixes can be used for boolean variables. Messages are prefixed with 'msg-', followed by their message key. All messages specified in the skin option 'messages' will be available under 'msg-MESSAGE-NAME'.

Returns
array Data for a mustache template

Reimplemented in SkinTemplate, SkinMustache, and SkinFallback.

Definition at line 131 of file Skin.php.

References $title, getContext(), MediaWiki\Rest\Handler\getRequest(), getTitle(), getUser(), and Html\rawElement().

◆ getUndeleteLink()

Skin::getUndeleteLink ( )

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

References VERSION_MAJOR.

◆ initPage()

Skin::initPage ( OutputPage  $out)
Stability: stable
to override
Parameters
OutputPage$out

Reimplemented in SkinFallback.

Definition at line 311 of file Skin.php.

References OutputPage\addMeta(), and OutputPage\getHTMLTitle().

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

Referenced by OutputPage\headElement().

◆ lastModified()

Skin::lastModified ( )
protected

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

Access: internal
Deprecated:
since 1.40
Returns
string

Definition at line 920 of file Skin.php.

References wfDeprecated().

◆ logoText()

Skin::logoText (   $align = '')
Parameters
string$align
Returns
string

Definition at line 929 of file Skin.php.

References MediaWiki\ResourceLoader\SkinModule\getAvailableLogos(), and Title\newMainPage().

Referenced by SkinTemplate\prepareQuickTemplate().

◆ makeFooterIcon()

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

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

Stable to use since 1.40 but should not be overridden.

Parameters
array$iconThe icon to build the html for, see $wgFooterIcons for the format of this array.
bool | string$withImageWhether to use the icon's image or output a text-only footericon.
Returns
string HTML

Definition at line 970 of file Skin.php.

References MWDebug\detectDeprecatedOverride().

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

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

Referenced by LoginSignupSpecialPage\getFieldDefinitions(), and EditPage\showStandardInputs().

◆ 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 | Title$nameArticle name
string | array$urlaction
Returns
array

Definition at line 1135 of file Skin.php.

References $title, and Title\newFromText().

Referenced by SkinTemplate\setupTemplateContext().

◆ makeLink()

Skin::makeLink (   $key,
  $item,
  $linkOptions = [] 
)
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$keyUsually a key from the list you are generating this link from.
array$itemContains some of a specific set of keys.

If "html" key is present, this will be returned. All other keys will be ignored.

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 'link-html' key can be used to prepend additional HTML inside the link HTML. For example to prepend an icon.

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$linkOptionsCan 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 2076 of file Skin.php.

References getContext().

◆ makeListItem()

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

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

list

Since
1.35
Parameters
string$keyUsually a key from the list you are generating this link from.
array$itemArray 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 2118 of file Skin.php.

References getContext().

Referenced by SkinTemplate\makePersonalToolsList().

◆ makeMainPageUrl()

static Skin::makeMainPageUrl (   $urlaction = '')
static
Parameters
string | array$urlaction
Returns
string

Definition at line 1063 of file Skin.php.

References $title, and Title\newMainPage().

◆ makeSearchButton()

Skin::makeSearchButton (   $mode,
  $attrs = [] 
)
Parameters
string$moderepresenting the type of button wanted either go, fulltext or image
array$attrs(optional)
Exceptions
MWExceptionif bad value of $mode passed in
Deprecated:
1.39 use $this->getTemplateData()['data-search-box'] instead. Note: When removing this function please merge SkinTemplate::makeSearchButtonInternal with SkinTemplate::makeSearchButton.
Returns
string of HTML button

Reimplemented in SkinTemplate.

Definition at line 2158 of file Skin.php.

References SkinTemplate\makeSearchButtonInternal(), and wfDeprecated().

◆ makeSearchInput()

Skin::makeSearchInput (   $attrs = [])
Since
1.35
Parameters
array$attrs(optional) will be passed to tooltipAndAccesskeyAttribs and decorate the resulting input
Deprecated:
1.39 use $this->getTemplateData()['data-search-box'] instead.
Returns
string of HTML input

Reimplemented in SkinTemplate.

Definition at line 2132 of file Skin.php.

References Html\element(), and wfDeprecated().

◆ 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$nameName of the Special page
string | array$urlactionQuery to append
string | null$protoProtocol to use or null for a local URL
Returns
string

Definition at line 1080 of file Skin.php.

References $title, and SpecialPage\getSafeTitleFor().

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

◆ makeSpecialUrlSubpage()

static Skin::makeSpecialUrlSubpage (   $name,
  $subpage,
  $urlaction = '' 
)
static
Parameters
string$name
string | bool$subpagefalse for no subpage
string | array$urlaction
Returns
string

Definition at line 1095 of file Skin.php.

References $title, and SpecialPage\getSafeTitleFor().

Referenced by SkinTemplate\buildPersonalUrls().

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

◆ makeUrlDetails()

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

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

Parameters
string | Title$name
string | array$urlaction
Returns
array

Definition at line 1121 of file Skin.php.

References $title, and Title\newFromText().

Referenced by SkinTemplate\setupTemplateContext().

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

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

References $fallback.

Referenced by ApiQuerySiteinfo\appendSkins(), ApiParse\execute(), and RequestContext\getSkin().

◆ outputPage()

Skin::outputPage ( )
abstract

Outputs the HTML generated by other functions.

Reimplemented in SkinTemplate.

◆ prepareSubtitle()

Skin::prepareSubtitle ( bool  $withContainer = true)
final

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

Since
1.35
Parameters
bool$withContainersince 1.40, when provided the mw-content-subtitle element will be output too.
Returns
string HTML

Definition at line 2198 of file Skin.php.

References Html\rawElement().

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

◆ prepareUndeleteLink()

Skin::prepareUndeleteLink ( )
finalprotected

Prepare undelete link for output in page.

Since
1.38 on Skin and 1.35 on classes extending SkinTemplate
Returns
null|string HTML, or null if there is no undelete link.

Definition at line 2259 of file Skin.php.

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

◆ prepareUserLanguageAttributes()

Skin::prepareUserLanguageAttributes ( )
finalprotected

Prepare user language attribute links.

Since
1.38 on Skin and 1.35 on classes extending SkinTemplate
Returns
string HTML attributes

Definition at line 2248 of file Skin.php.

References Html\expandAttributes().

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

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

References wfExpandIRI().

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

◆ setRelevantTitle()

Skin::setRelevantTitle (   $t)
See also
self::getRelevantTitle()
Parameters
Title$t

Definition at line 476 of file Skin.php.

References $t.

◆ setRelevantUser()

Skin::setRelevantUser ( ?UserIdentity  $u)
See also
self::getRelevantUser()
Parameters
UserIdentity | null$u

Definition at line 499 of file Skin.php.

◆ showEmailUser()

Skin::showEmailUser (   $id)
Parameters
UserIdentity | int$id
Returns
bool

Definition at line 1044 of file Skin.php.

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

◆ supportsMenu()

Skin::supportsMenu ( string  $menu)

Does the skin support the named menu?

Since
1.39
Parameters
string$menuSee Skin::getOptions for menu names.
Returns
bool

Definition at line 2348 of file Skin.php.

◆ wrapHTML()

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

Wrap the body text with language information and identifiable element.

Since
1.38 in Skin, previously was a method of SkinTemplate
Parameters
Title$title
string$htmlbody text
Returns
string html

Definition at line 2281 of file Skin.php.

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

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

Member Data Documentation

◆ $mRelevantTitle

Skin::$mRelevantTitle = null
protected

Definition at line 69 of file Skin.php.

◆ $options

array Skin::$options = []
protected

Skin options passed into constructor.

Definition at line 68 of file Skin.php.

Referenced by SkinTemplate\generateHTML(), and SkinTemplate\makePersonalToolsList().

◆ $skinname

string null Skin::$skinname = null
protected

Definition at line 63 of file Skin.php.

◆ VERSION_MAJOR

const Skin::VERSION_MAJOR = 1
protected

The current major version of the skin specification.

Definition at line 77 of file Skin.php.

Referenced by getVersion().


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