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

	msgHtml ( $str)

	msgWiki ( $str)
	An ugly, ugly hack.

	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.

	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.

	getInterlanguageLinks ()
	Interlanguage links block, also with variants.

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

	getMainNavigation ()
	Left sidebar navigation, usually.

	getPageTools ()
	Generate pile of all the tools.

	getPageToolSidebar ()
	Page tools in sidebar.

	getPortlet ( $name, $content, $msg=null)
	Generates a block of navigation links with a header.

	getSearch ()
	The search box at the top.

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

	getSiteNotices ()
	Notices that may appear above the firstHeading.

	getUserLinks ()
	Personal/user links portlet for header.

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	$pileOfTools

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 15 of file TimelessTemplate.php.

References $html, getAfterContent(), getCategories(), BaseTemplate\getClear(), getContentSub(), getContext(), BaseTemplate\getFooter(), getHeaderHack(), BaseTemplate\getIndicators(), getInterlanguageLinks(), getLogo(), getMainNavigation(), BaseTemplate\getMsg(), getPageTools(), getPageToolSidebar(), getPortlet(), getSearch(), getSidebarChunk(), getSiteNotices(), 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 556 of file TimelessTemplate.php.

References $html.

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 710 of file TimelessTemplate.php.

References $html, 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 764 of file TimelessTemplate.php.

References $html, and getPortlet().

Referenced by getCategories().

◆ getContentSub()

TimelessTemplate::getContentSub ( )

protected

Links and information that may appear below the firstHeading.

Returns: string html

Definition at line 535 of file TimelessTemplate.php.

References $html.

Referenced by execute().

◆ 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 381 of file TimelessTemplate.php.

References $html.

Referenced by execute().

◆ getInterlanguageLinks()

TimelessTemplate::getInterlanguageLinks ( )

protected

Interlanguage links block, also with variants.

Returns: string html

Definition at line 790 of file TimelessTemplate.php.

References $html, 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 260 of file TimelessTemplate.php.

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

Referenced by execute().

◆ getMainNavigation()

TimelessTemplate::getMainNavigation ( )

protected

Left sidebar navigation, usually.

Returns: string html

Definition at line 350 of file TimelessTemplate.php.

References $content, $html, getPortlet(), BaseTemplate\getSidebar(), getSidebarChunk(), and string.

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 582 of file TimelessTemplate.php.

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

Referenced by execute().

◆ getPageToolSidebar()

TimelessTemplate::getPageToolSidebar ( )

protected

Page tools in sidebar.

Returns: string html

Definition at line 410 of file TimelessTemplate.php.

References getPortlet(), and getSidebarChunk().

Referenced by execute().

◆ getPortlet()

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

protected

Generates a block of navigation links with a header.

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

Returns: string html

Since: 1.29

Definition at line 145 of file TimelessTemplate.php.

References $content, $html, $name, $template, BaseTemplate\getAfterPortlet(), BaseTemplate\getMsg(), BaseTemplate\makeListItem(), and Linker\titleAttrib().

Referenced by execute(), getCatList(), getInterlanguageLinks(), getMainNavigation(), getPageToolSidebar(), and getUserLinks().

◆ getSearch()

TimelessTemplate::getSearch ( )

protected

The search box at the top.

Returns: string html

Definition at line 310 of file TimelessTemplate.php.

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

Referenced by execute().

◆ getSidebarChunk()

TimelessTemplate::getSidebarChunk	(	$id,
		$headerMessage,
		$content )

protected

Sidebar chunk containing one or more portlets.

Parameters

string	$id
string	$headerMessage
string	$content

Returns: string html

Definition at line 234 of file TimelessTemplate.php.

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

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

◆ getSiteNotices()

TimelessTemplate::getSiteNotices ( )

protected

Notices that may appear above the firstHeading.

Returns: string html

Definition at line 517 of file TimelessTemplate.php.

References $html.

Referenced by execute().

◆ 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 437 of file TimelessTemplate.php.

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

Referenced by execute().

Member Data Documentation

◆ $pileOfTools

array TimelessTemplate::$pileOfTools

protected

Definition at line 10 of file TimelessTemplate.php.

Referenced by getPageTools().

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

◆ getContentSub()

◆ getHeaderHack()

◆ getInterlanguageLinks()

◆ getLogo()

◆ getMainNavigation()

◆ getPageTools()

◆ getPageToolSidebar()

◆ getPortlet()

◆ getSearch()

◆ getSidebarChunk()

◆ getSiteNotices()

◆ getUserLinks()

Member Data Documentation

◆ $pileOfTools