MediaWiki master
MediaWiki\Skin\SkinComponentFooter Class Reference

Inherits MediaWiki\Skin\SkinComponent.

Collaboration diagram for MediaWiki\Skin\SkinComponentFooter:

Public Member Functions

 __construct (SkinComponentRegistryContext $skinContext)
 
 getTemplateData ()
 This returns all the data that is needed to the component.Returned array must be serialized. This will be passed directly to a template (usually Mustache) for rendering.
Returns
array Data related to component required to render.

 

Static Public Member Functions

static getFooterIconsData (Config $config)
 Get data representation of icons.
 
static makeFooterIconHTML (Config $config, $icon, string $withImage='withImage')
 Renders a $wgFooterIcons icon according to the method's arguments.
 

Detailed Description

Definition at line 14 of file SkinComponentFooter.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Skin\SkinComponentFooter::__construct ( SkinComponentRegistryContext  $skinContext)
Parameters
SkinComponentRegistryContext$skinContext

Definition at line 21 of file SkinComponentFooter.php.

Member Function Documentation

◆ getFooterIconsData()

static MediaWiki\Skin\SkinComponentFooter::getFooterIconsData ( Config  $config)
static

Get data representation of icons.

Access: internal
for use in Skin only
Parameters
Config$config
Returns
array

Definition at line 236 of file SkinComponentFooter.php.

References MediaWiki\Config\Config\get().

◆ getTemplateData()

MediaWiki\Skin\SkinComponentFooter::getTemplateData ( )

This returns all the data that is needed to the component.Returned array must be serialized. This will be passed directly to a template (usually Mustache) for rendering.

Returns
array Data related to component required to render.

Implements MediaWiki\Skin\SkinComponent.

Definition at line 54 of file SkinComponentFooter.php.

◆ makeFooterIconHTML()

static MediaWiki\Skin\SkinComponentFooter::makeFooterIconHTML ( Config  $config,
  $icon,
string  $withImage = 'withImage' 
)
static

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

Parameters
Config$config
array | string$iconThe icon to build the html for, see $wgFooterIcons for the format of this array.
string$withImageWhether to use the icon's image or output a text-only footer icon.
Returns
string HTML
Access: internal
for use in Skin only

Definition at line 204 of file SkinComponentFooter.php.


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