MediaWiki REL1_32
SkinVector Class Reference

Skin subclass for Vector. More...

Inheritance diagram for SkinVector:
Collaboration diagram for SkinVector:

Public Member Functions

 __construct ()
 
 enableResponsiveMode ()
 Enables the responsive mode.
 
 getPageClasses ( $title)
 @inheritDoc
 
 initPage (OutputPage $out)
 Initializes output page and sets up skin-specific parameters.
 
 setupSkinUserCss (OutputPage $out)
 Loads skin and user CSS files.
 
 setupTemplate ( $classname, $repository=false, $cache_dir=false)
 Override to pass our Config instance to it.
 
 shouldPreloadLogo ()
 Whether the logo should be preloaded with an HTTP link header or not.
 
- Public Member Functions inherited from SkinTemplate
 formatLanguageName ( $name)
 Format language name for use in sidebar interlanguage links list.
 
 getLanguages ()
 Generates array of language links for the current page.
 
 getPersonalToolsList ()
 Get the HTML for the p-personal list.
 
 getStructuredPersonalTools ()
 Get personal tools for the user.
 
 makeArticleUrlDetails ( $name, $urlaction='')
 
 makePersonalToolsList ( $personalTools=null, $options=[])
 Get the HTML for the personal tools list.
 
 makeTalkUrlDetails ( $name, $urlaction='')
 
 outputPage (OutputPage $out=null)
 initialize various variables and generate the template
 
 printOrError ( $str)
 Output the string, or print error message if it's an error object of the appropriate type.
 
 tabAction ( $title, $message, $selected, $query='', $checkEdit=false)
 Builds an array with tab definition.
 
 useCombinedLoginLink ()
 Output a boolean indicating if buildPersonalUrls should output separate login and create account links or output a combined link By default we simply return a global config setting that affects most skins This is setup as a method so that like with $wgLogo and getLogo() a skin can override this setting and always output one or the other if it has a reason it can't output one of the two modes.
 
- Public Member Functions inherited from Skin
 __construct ( $skinname=null)
 
 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.
 
 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)
 Returns an HTML link for use in the footer.
 
 getCategories ()
 
 getCategoryLinks ()
 
 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.
 
 getHtmlElementAttributes ()
 Return values for <html> element.
 
 getLogo ()
 URL to the logo.
 
 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)
 
 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 skin's folder.
 
 getUndeleteLink ()
 
 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.
 
 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.
 
 showEmailUser ( $id)
 
 subPageSubtitle ( $out=null)
 
- 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.
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object.
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 

Public Attributes

 $skinname = 'vector'
 
 $stylename = 'Vector'
 
 $template = 'VectorTemplate'
 
- Public Attributes inherited from SkinTemplate
 $loggedin
 
string $skinname = 'monobook'
 Name of our skin, it probably needs to be all lower case.
 
string $template = QuickTemplate::class
 For QuickTemplate, the name of the subclass which will actually fill the template.
 
 $thispage
 
 $thisquery
 
 $titletxt
 
 $username
 
 $userpage
 
 $userpageUrlDetails
 
- Public Attributes inherited from Skin
string $stylename = null
 Stylesheets set to use.
 

Private Attributes

 $responsiveMode = false
 
Config $vectorConfig
 

Additional Inherited Members

- Static Public Member Functions inherited from Skin
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 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 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, $nonce=null)
 
static normalizeKey ( $key)
 Normalize a skin preference value to a form that can be loaded.
 
- Protected Member Functions inherited from SkinTemplate
 buildContentNavigationUrls ()
 a structured array of links usually used for the tabs in a skin
 
 buildNavUrls ()
 build array of common navigation links
 
 buildPersonalUrls ()
 build array of urls for personal toolbar
 
 getNameSpaceKey ()
 Generate strings used for xml 'id' names.
 
 prepareQuickTemplate ()
 initialize various variables and generate the template
 
 setupTemplateForOutput ()
 
 wrapHTML ( $title, $html)
 Wrap the body text with language information and identifiable element.
 
- Protected Member Functions inherited from Skin
 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.
 
 preloadExistence ()
 Preload the existence of three commonly-requested pages in a single query.
 
- Protected Attributes inherited from Skin
 $mRelevantTitle = null
 
 $mRelevantUser = null
 
string null $skinname = null
 

Detailed Description

Skin subclass for Vector.

Definition at line 29 of file SkinVector.php.

Constructor & Destructor Documentation

◆ __construct()

SkinVector::__construct ( )

Definition at line 39 of file SkinVector.php.

Member Function Documentation

◆ enableResponsiveMode()

SkinVector::enableResponsiveMode ( )

Enables the responsive mode.

Definition at line 53 of file SkinVector.php.

References $out, and ContextSource\getOutput().

Referenced by initPage().

◆ getPageClasses()

SkinVector::getPageClasses ( $title)

@inheritDoc

Reimplemented from Skin.

Definition at line 45 of file SkinVector.php.

◆ initPage()

SkinVector::initPage ( OutputPage $out)

Initializes output page and sets up skin-specific parameters.

Parameters
OutputPage$outObject to initialize

Reimplemented from Skin.

Definition at line 66 of file SkinVector.php.

References $out, and enableResponsiveMode().

◆ setupSkinUserCss()

SkinVector::setupSkinUserCss ( OutputPage $out)

Loads skin and user CSS files.

Parameters
OutputPage$out

Reimplemented from Skin.

Definition at line 80 of file SkinVector.php.

References $out.

◆ setupTemplate()

SkinVector::setupTemplate ( $classname,
$repository = false,
$cache_dir = false )

Override to pass our Config instance to it.

Parameters
string$classname
bool | string$repository
bool | string$cache_dir
Returns
QuickTemplate

Reimplemented from SkinTemplate.

Definition at line 96 of file SkinVector.php.

◆ shouldPreloadLogo()

SkinVector::shouldPreloadLogo ( )

Whether the logo should be preloaded with an HTTP link header or not.

Since
1.29
Returns
bool

Reimplemented from Skin.

Definition at line 105 of file SkinVector.php.

Member Data Documentation

◆ $responsiveMode

SkinVector::$responsiveMode = false
private

Definition at line 37 of file SkinVector.php.

◆ $skinname

SkinVector::$skinname = 'vector'

Definition at line 30 of file SkinVector.php.

◆ $stylename

SkinVector::$stylename = 'Vector'

Definition at line 31 of file SkinVector.php.

◆ $template

SkinVector::$template = 'VectorTemplate'

Definition at line 32 of file SkinVector.php.

◆ $vectorConfig

Config SkinVector::$vectorConfig
private

Definition at line 36 of file SkinVector.php.


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