BaseTemplate class for the Timeless skin. More...

Inheritance diagram for TimelessTemplate:

[legend]

Collaboration diagram for TimelessTemplate:

[legend]

Public Member Functions
	execute ()
	Outputs the entire contents of the page.

Public Member Functions inherited from BaseTemplate
	getFooterIcons ( $option=null)
	Returns an array of footer icons filtered down by options relevant to how the skin wishes to display them.

	getFooterLinks ( $option=null)
	Returns an array of footerlinks trimmed down to only those footer links that are valid.

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

	getMsg ( $name,... $params)
	Get a Message object with its context set.

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

	getSidebar ( $options=[])

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

	getTrail ()
	Get the basic end-page trail including bottomscripts, reporttime, and debug stuff.

	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=[])

	msg ( $str)

	msgWiki ( $str)

	printTrail ()
	Output getTrail.

Public Member Functions inherited from QuickTemplate
	__construct (Config $config=null)

	extend ( $name, $value)
	extends the value of data with name $name with the value $value

	get ( $name, $default=null)
	Gets the template data requested.

	getHTML ()
	Fetch the output of a QuickTemplate and return it.

	getSkin ()
	Get the Skin object related to this object.

	haveData ( $str)

	haveMsg ( $msgKey)

	html ( $str)

	set ( $name, $value)
	Sets the value $value to $name.

	setRef ( $name, &$value)

	text ( $str)

Protected Member Functions
	getAfterContent ()
	The data after content, catlinks, and potential other stuff that may appear within the content block but after the main content.

	getCategories ()
	Categories for the sidebar.

	getCatList ( $list, $id, $class, $message)
	List of categories.

	getContentBlock ()
	Generate the page content block Broken out here due to the excessive indenting, or stuff.

	getContentSub ()
	Links and information that may appear below the firstHeading.

	getHeaderHack ()
	The colour bars Split this out so we don't have to look at it/can easily kill it later.

	getInterwikiLinks ()
	Interwiki links block.

	getLogo ( $id='p-logo', $part='both')
	The logo and (optionally) site title.

	getLogoImage ( $logo, $doLarge=false)
	Generate img-based logos for proper HiDPI support.

	getMainNavigation ()
	Left sidebar navigation, usually.

	getPageTools ()
	Generate pile of all the tools.

	getPageToolSidebar ()
	Page tools in sidebar.

	getPortlet ( $name, $content, $msg=null, $setOptions=[])
	Generates a block of navigation links with a header This is some random fork of some random fork of what was supposed to be in core.

	getSearch ()
	The search box at the top.

	getSidebarChunk ( $id, $headerMessage, $content, $classes=[])
	Sidebar chunk containing one or more portlets.

	getSiteNotices ()
	Notices that may appear above the firstHeading.

	getUserLinks ()
	Personal/user links portlet for header.

	getVariants ()
	Interlanguage links block, with variants if applicable Layout sort of assumes we're using ULS compact language handling if there's a lot of languages.

	mergeClasses ( $class, $extraClasses)
	Helper function for getPortlet.

Protected Member Functions inherited from BaseTemplate
	getAfterPortlet ( $name)
	Allows extensions to hook into known portlets and add stuff to them.

	getClear ()
	Get a div with the core visualClear class, for clearing floats.

	getFooter ( $iconStyle='icononly', $linkStyle='flat')
	Renderer for getFooterIcons and getFooterLinks.

	renderAfterPortlet ( $name)

Protected Attributes
array null	$collectionPortlet

array null	$otherProjects

array	$pileOfTools

array	$sidebar

Protected Attributes inherited from QuickTemplate
	$config

Additional Inherited Members
Public Attributes inherited from QuickTemplate
array	$data

Detailed Description

BaseTemplate class for the Timeless skin.

Definition at line 7 of file TimelessTemplate.php.

Member Function Documentation

◆ execute()

TimelessTemplate::execute ( )

Outputs the entire contents of the page.

Reimplemented from QuickTemplate.

Definition at line 24 of file TimelessTemplate.php.

References getAfterContent(), getCategories(), BaseTemplate\getClear(), getContentBlock(), getContext(), BaseTemplate\getFooter(), getHeaderHack(), getInterwikiLinks(), getLogo(), getMainNavigation(), getPageTools(), getPageToolSidebar(), getPortlet(), getSearch(), BaseTemplate\getSidebar(), getSidebarChunk(), QuickTemplate\getSkin(), and getUserLinks().

◆ getAfterContent()

TimelessTemplate::getAfterContent ( )

protected

The data after content, catlinks, and potential other stuff that may appear within the content block but after the main content.

Returns: string html

Definition at line 652 of file TimelessTemplate.php.

Referenced by execute().

◆ getCategories()

TimelessTemplate::getCategories ( )

protected

Categories for the sidebar.

Assemble an array of categories. This doesn't show any categories for the action=history view, but that behaviour is consistent with other skins.

Returns: string html

Definition at line 845 of file TimelessTemplate.php.

References getCatList(), getSidebarChunk(), QuickTemplate\getSkin(), and NS_CATEGORY.

Referenced by execute().

◆ getCatList()

TimelessTemplate::getCatList	(	$list,
		$id,
		$class,
		$message )

protected

List of categories.

Parameters

array	$list
string	$id
string \| array	$class
string \| array	$message	i18n message name or an array of [ message name, params ]

Returns: string html

Definition at line 899 of file TimelessTemplate.php.

References getPortlet().

Referenced by getCategories().

◆ getContentBlock()

TimelessTemplate::getContentBlock ( )

protected

Generate the page content block Broken out here due to the excessive indenting, or stuff.

Returns: string html

Definition at line 114 of file TimelessTemplate.php.

References BaseTemplate\getClear(), getContentSub(), BaseTemplate\getIndicators(), BaseTemplate\getMsg(), getPortlet(), getSiteNotices(), and getVariants().

Referenced by execute().

◆ getContentSub()

TimelessTemplate::getContentSub ( )

protected

Links and information that may appear below the firstHeading.

Returns: string html

Definition at line 631 of file TimelessTemplate.php.

Referenced by getContentBlock().

◆ getHeaderHack()

TimelessTemplate::getHeaderHack ( )

protected

The colour bars Split this out so we don't have to look at it/can easily kill it later.

Returns: string html

Definition at line 477 of file TimelessTemplate.php.

Referenced by execute().

◆ getInterwikiLinks()

TimelessTemplate::getInterwikiLinks ( )

protected

Interwiki links block.

Returns: string html

Definition at line 947 of file TimelessTemplate.php.

References $languages, getPortlet(), and getSidebarChunk().

Referenced by execute().

◆ getLogo()

TimelessTemplate::getLogo	(		$id = 'p-logo',
			$part = 'both' )

protected

The logo and (optionally) site title.

Parameters

string	$id
string	$part	whether it's only image, only text, or both

Returns: string html

Definition at line 343 of file TimelessTemplate.php.

References QuickTemplate\$config, getLogoImage(), BaseTemplate\getMsg(), QuickTemplate\getSkin(), and Linker\tooltipAndAccesskeyAttribs().

Referenced by execute().

◆ getLogoImage()

TimelessTemplate::getLogoImage	(		$logo,
			$doLarge = false )

protected

Generate img-based logos for proper HiDPI support.

Parameters

string \| array \| null	$logo
bool	$doLarge	Render extra-large HiDPI logos for mobile devices?

Returns: string|false html|we're not doing this

Definition at line 1002 of file TimelessTemplate.php.

References $file, $path, $res, BaseTemplate\getMsg(), and wfFindFile().

Referenced by getLogo().

◆ getMainNavigation()

TimelessTemplate::getMainNavigation ( )

protected

Left sidebar navigation, usually.

Returns: string html

Definition at line 447 of file TimelessTemplate.php.

References $content, getPortlet(), and getSidebarChunk().

Referenced by execute().

◆ getPageTools()

TimelessTemplate::getPageTools ( )

protected

Generate pile of all the tools.

We can make a few assumptions based on where a tool started out: If it's in the cactions region, it's a page tool, probably primary or secondary ...that's all I can think of

Returns: array of array of tools information (portlet formatting)

Definition at line 678 of file TimelessTemplate.php.

References $pileOfTools, $title, BaseTemplate\getMsg(), QuickTemplate\getSkin(), and BaseTemplate\getToolbox().

Referenced by execute().

◆ getPageToolSidebar()

TimelessTemplate::getPageToolSidebar ( )

protected

Page tools in sidebar.

Returns: string html

Definition at line 506 of file TimelessTemplate.php.

References getPortlet(), and getSidebarChunk().

Referenced by execute().

◆ getPortlet()

TimelessTemplate::getPortlet	(	$name,
		$content,
		$msg = null,
		$setOptions = [] )

protected

Generates a block of navigation links with a header This is some random fork of some random fork of what was supposed to be in core.

Latest version copied out of MonoBook, probably. (20190719)

Parameters

string	$name
array \| string	$content	array of links for use with makeListItem, or a block of text Expected array format: [ $name => [ 'links' => [ '0' => [ 'href' => ..., 'single-id' => ..., 'text' => ... ] ], 'id' => ..., 'active' => ... ], ... ]
null \| string \| array \| bool	$msg
array	$setOptions	miscellaneous overrides, see below

Returns: string html

Definition at line 191 of file TimelessTemplate.php.

References $content, BaseTemplate\getAfterPortlet(), BaseTemplate\getMsg(), BaseTemplate\makeListItem(), mergeClasses(), and Linker\titleAttrib().

Referenced by execute(), getCatList(), getContentBlock(), getInterwikiLinks(), getMainNavigation(), getPageToolSidebar(), getUserLinks(), and getVariants().

◆ getSearch()

TimelessTemplate::getSearch ( )

protected

The search box at the top.

Returns: string html

Definition at line 407 of file TimelessTemplate.php.

References BaseTemplate\getMsg(), BaseTemplate\makeSearchButton(), and BaseTemplate\makeSearchInput().

Referenced by execute().

◆ getSidebarChunk()

TimelessTemplate::getSidebarChunk	(	$id,
		$headerMessage,
		$content,
		$classes = [] )

protected

Sidebar chunk containing one or more portlets.

Parameters

string	$id
string	$headerMessage
string	$content
array	$classes

Returns: string html

Definition at line 315 of file TimelessTemplate.php.

References $content, BaseTemplate\getMsg(), and QuickTemplate\text().

Referenced by execute(), getCategories(), getInterwikiLinks(), getMainNavigation(), and getPageToolSidebar().

◆ getSiteNotices()

TimelessTemplate::getSiteNotices ( )

protected

Notices that may appear above the firstHeading.

Returns: string html

Definition at line 613 of file TimelessTemplate.php.

Referenced by getContentBlock().

◆ getUserLinks()

TimelessTemplate::getUserLinks ( )

protected

Personal/user links portlet for header.

Returns: array [ html, class ], where class is an extra class to apply to surrounding objects (for width adjustments)

Definition at line 539 of file TimelessTemplate.php.

References BaseTemplate\getMsg(), BaseTemplate\getPersonalTools(), getPortlet(), QuickTemplate\getSkin(), and BaseTemplate\makeListItem().

Referenced by execute().

◆ getVariants()

TimelessTemplate::getVariants ( )

protected

Interlanguage links block, with variants if applicable Layout sort of assumes we're using ULS compact language handling if there's a lot of languages.

Returns: string html

Definition at line 927 of file TimelessTemplate.php.

References getPortlet().

Referenced by getContentBlock().

◆ mergeClasses()

TimelessTemplate::mergeClasses	(		$class,
			$extraClasses )

protected

Helper function for getPortlet.

Merge all provided css classes into a single array Account for possible different input methods matching what Html::element stuff takes

Parameters

string \| array	$class	base portlet/body class
string \| array	$extraClasses	any extra classes to also include

Returns: array all classes to apply

Definition at line 294 of file TimelessTemplate.php.

Referenced by getPortlet().

Member Data Documentation

◆ $collectionPortlet

array null TimelessTemplate::$collectionPortlet

protected

Definition at line 19 of file TimelessTemplate.php.

◆ $otherProjects

array null TimelessTemplate::$otherProjects

protected

Definition at line 16 of file TimelessTemplate.php.

◆ $pileOfTools

array TimelessTemplate::$pileOfTools

protected

Definition at line 10 of file TimelessTemplate.php.

Referenced by getPageTools().

◆ $sidebar

array TimelessTemplate::$sidebar

protected

Definition at line 13 of file TimelessTemplate.php.

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

skins/Timeless/includes/TimelessTemplate.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ execute()

◆ getAfterContent()

◆ getCategories()

◆ getCatList()

◆ getContentBlock()

◆ getContentSub()

◆ getHeaderHack()

◆ getInterwikiLinks()

◆ getLogo()

◆ getLogoImage()

◆ getMainNavigation()

◆ getPageTools()

◆ getPageToolSidebar()

◆ getPortlet()

◆ getSearch()

◆ getSidebarChunk()

◆ getSiteNotices()

◆ getUserLinks()

◆ getVariants()

◆ mergeClasses()

Member Data Documentation

◆ $collectionPortlet

◆ $otherProjects

◆ $pileOfTools

◆ $sidebar