Extended QuickTemplate with additional MediaWiki-specific helper methods. More...

Collaboration diagram for BaseTemplate:

[legend]

Public Member Functions
	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 ()

	getToolbox ()
	Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate and items added by hook to the 'toolbox' section.

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

	makeListItem ( $key, $item, $options=[])
	Wrapper for Skin method.

	msg ( $str)

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

	deprecate (string $name, string $version)
	Sets a template key as deprecated.

	execute ()
	Main function, used by classes that subclass QuickTemplate to show the actual HTML output.

	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.

	html ( $str)

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

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

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

	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.

	getSidebar ( $options=[])

	makeLink ( $key, $item, $options=[])
	Wrapper for Skin method.

	makeSearchButton ( $mode, $attrs=[])
	Wrapper for Skin method.

	makeSearchInput ( $attrs=[])
	Wrapper for Skin method.

	printTrail ()
	Output getTrail.

Protected Member Functions inherited from QuickTemplate
	haveMsg ( $msgKey)

	text ( $str)

Additional Inherited Members
Public Attributes inherited from QuickTemplate
array	$data

Protected Attributes inherited from QuickTemplate
Config	$config

Detailed Description

Extended QuickTemplate with additional MediaWiki-specific helper methods.

Todo: Phase this class out and make it an alias for QuickTemplate. Move methods individually as-appropriate either down to QuickTemplate, or (with deprecation) up to SkinTemplate.

Stability: stable: to extend

Definition at line 34 of file BaseTemplate.php.

Member Function Documentation

◆ getClear()

BaseTemplate::getClear ( )

protected

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

Returns: string html

Since: 1.29

Definition at line 371 of file BaseTemplate.php.

Referenced by getFooter().

◆ getFooter()

BaseTemplate::getFooter	(		$iconStyle = 'icononly',
			$linkStyle = 'flat' )

protected

Renderer for getFooterIcons and getFooterLinks.

Parameters

string	$iconStyle	$option for getFooterIcons: "icononly", "nocopyright" the "nocopyright" option is deprecated in 1.35 because of its association with getFooterIcons
string	$linkStyle	$option for getFooterLinks: "flat"

Returns: string html

Since: 1.29

Definition at line 314 of file BaseTemplate.php.

References getClear(), getFooterIcons(), getFooterLinks(), and QuickTemplate\getSkin().

◆ getFooterIcons()

BaseTemplate::getFooterIcons ( $option = null )

protected

Returns an array of footer icons filtered down by options relevant to how the skin wishes to display them.

If you pass "icononly" as the option all footer icons which do not have an image icon set will be filtered out. If you pass "nocopyright" then MediaWiki's copyright icon will not be included in the list of footer icons. This is mostly useful for skins which only display the text from footericons instead of the images and don't want a duplicate copyright statement because footerlinks already rendered one.

Parameters

string | null $option

Deprecated: since 1.35 read footer icons from template data requested via $this->get('footericons')

Returns: array

Definition at line 269 of file BaseTemplate.php.

References wfDeprecated().

Referenced by getFooter().

◆ getFooterLinks()

BaseTemplate::getFooterLinks ( $option = null )

protected

Returns an array of footerlinks trimmed down to only those footer links that are valid.

If you pass "flat" as an option then the returned array will be a flat array of footer icons instead of a key/value array of footerlinks arrays broken up into categories.

Parameters

string | null $option

Returns: array|mixed

Definition at line 230 of file BaseTemplate.php.

Referenced by getFooter().

◆ getIndicators()

BaseTemplate::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.

Your skin may implement this differently, for example by handling some indicator names specially with a different UI. However, it is recommended to use a <div class="mw-indicator" id="mw-indicator-<id>" /> as a wrapper element for each indicator, for better compatibility with extensions and user scripts.

The raw data is available in ‘$this->data['indicators’]` as an associative array (keys: identifiers, values: contents) internally ordered by keys.

Returns: string HTML

Since: 1.25

Definition at line 390 of file BaseTemplate.php.

References $content.

◆ getMsg()

BaseTemplate::getMsg	(		$name,
			$params )

Get a Message object with its context set.

Parameters

string	$name	Message name
	mixed	...$params Message params

Returns: Message

Definition at line 43 of file BaseTemplate.php.

References QuickTemplate\getSkin().

Referenced by getSidebar(), and msg().

◆ getPersonalTools()

BaseTemplate::getPersonalTools ( )

Returns: array

Definition at line 81 of file BaseTemplate.php.

References QuickTemplate\getSkin().

◆ getSidebar()

BaseTemplate::getSidebar ( $options = [] )

protected

Parameters

array $options (optional) allows disabling certain sidebar elements. The keys search, toolbox and languages are accepted.

Returns: array representing the sidebar

Definition at line 90 of file BaseTemplate.php.

References $content, getMsg(), and QuickTemplate\getSkin().

◆ getToolbox()

BaseTemplate::getToolbox ( )

Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate and items added by hook to the 'toolbox' section.

The resulting array is built according to a format intended to be passed through makeListItem to generate the html.

Deprecated: since 1.35. To add items to the toolbox, use SidebarBeforeOutput hook. To get the toolbox only use $this->data['sidebar']['TOOLBOX'], if you are extending this class.

Returns: array

Definition at line 62 of file BaseTemplate.php.

References QuickTemplate\getSkin(), and wfDeprecated().

◆ getTrail()

BaseTemplate::getTrail ( )

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

This should be called right before outputting the closing body and html tags.

Returns: string|WrappedStringList HTML

Since: 1.29

Deprecated: 1.39

Definition at line 427 of file BaseTemplate.php.

References QuickTemplate\getSkin(), and wfDeprecated().

Referenced by printTrail().

◆ makeLink()

BaseTemplate::makeLink	(	$key,
		$item,
		$options = [] )

protected

Wrapper for Skin method.

Parameters

string	$key	of link
array	$item	to render
array	$options	for link

Returns: string

Definition at line 184 of file BaseTemplate.php.

References QuickTemplate\getSkin().

◆ makeListItem()

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

Wrapper for Skin method.

Parameters

string	$key	of list item
array	$item	to render
array	$options	for list item

Returns: string

Definition at line 196 of file BaseTemplate.php.

References QuickTemplate\getSkin().

◆ makeSearchButton()

BaseTemplate::makeSearchButton	(		$mode,
			$attrs = [] )

protected

Wrapper for Skin method.

Parameters

string	$mode
array	$attrs

Returns: string

Definition at line 217 of file BaseTemplate.php.

References QuickTemplate\getSkin().

◆ makeSearchInput()

BaseTemplate::makeSearchInput ( $attrs = [] )

protected

Wrapper for Skin method.

Parameters

array $attrs

Returns: string

Definition at line 206 of file BaseTemplate.php.

References QuickTemplate\getSkin().

◆ msg()

BaseTemplate::msg ( $msgKey )

Parameters

string $msgKey

Reimplemented from QuickTemplate.

Definition at line 47 of file BaseTemplate.php.

References getMsg().

◆ printTrail()

BaseTemplate::printTrail ( )

protected

Output getTrail.

Deprecated: 1.39

Definition at line 413 of file BaseTemplate.php.

References getTrail(), and wfDeprecated().

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

includes/skins/BaseTemplate.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getClear()

◆ getFooter()

◆ getFooterIcons()

◆ getFooterLinks()

◆ getIndicators()

◆ getMsg()

◆ getPersonalTools()

◆ getSidebar()

◆ getToolbox()

◆ getTrail()

◆ makeLink()

◆ makeListItem()

◆ makeSearchButton()

◆ makeSearchInput()

◆ msg()

◆ printTrail()