MediaWiki  master
MediaWiki\Skin\SkinComponentRegistryContext Class Reference
Inheritance diagram for MediaWiki\Skin\SkinComponentRegistryContext:
Collaboration diagram for MediaWiki\Skin\SkinComponentRegistryContext:

Public Member Functions

 __construct (Skin $skin)
 
 getConfig ()
 Returns the config needed for the component.
Returns
Config
More...
 
 getContextSource ()
 
 getFooterIcons ()
 Temporarily allows access to Skin method. More...
 
 getLanguage ()
 
 getMessageLocalizer ()
 
 getOutput ()
 
 getRelevantTitle ()
 
 getTitle ()
 Returns the Title object for the component.
Returns
Title
More...
 
 getUser ()
 
 getWikiPage ()
 
 makeFooterIcon ( $icon, $withImage='withImage')
 Renders a $wgFooterIcons icon according to the method's arguments It exists to support skins overriding the method in MediaWiki 1.40 (overriding the method is now deprecated) It can be removed in 1.41. More...
 
 runHook (string $methodName, array $args)
 Run a hook. More...
 

Detailed Description

Access: internal
for use inside Skin and SkinTemplate classes only
Stability: unstable

Definition at line 36 of file SkinComponentRegistryContext.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Skin\SkinComponentRegistryContext::__construct ( Skin  $skin)
Parameters
Skin$skin

Definition at line 48 of file SkinComponentRegistryContext.php.

Member Function Documentation

◆ getConfig()

MediaWiki\Skin\SkinComponentRegistryContext::getConfig ( )

Returns the config needed for the component.

Returns
Config

Implements MediaWiki\Skin\ComponentRegistryContext.

Definition at line 62 of file SkinComponentRegistryContext.php.

◆ getContextSource()

MediaWiki\Skin\SkinComponentRegistryContext::getContextSource ( )
Returns
IContextSource

Definition at line 55 of file SkinComponentRegistryContext.php.

◆ getFooterIcons()

MediaWiki\Skin\SkinComponentRegistryContext::getFooterIcons ( )

Temporarily allows access to Skin method.

It exists to support skins overriding the method in MediaWiki 1.40 (overriding the method is now deprecated) It can be removed in 1.41

Stability: unstable
Access: internal
Returns
array

Definition at line 234 of file SkinComponentRegistryContext.php.

◆ getLanguage()

MediaWiki\Skin\SkinComponentRegistryContext::getLanguage ( )
Returns
Language $language

Definition at line 97 of file SkinComponentRegistryContext.php.

◆ getMessageLocalizer()

MediaWiki\Skin\SkinComponentRegistryContext::getMessageLocalizer ( )
Returns
MessageLocalizer

Definition at line 104 of file SkinComponentRegistryContext.php.

◆ getOutput()

MediaWiki\Skin\SkinComponentRegistryContext::getOutput ( )
Returns
OutputPage

Definition at line 83 of file SkinComponentRegistryContext.php.

◆ getRelevantTitle()

MediaWiki\Skin\SkinComponentRegistryContext::getRelevantTitle ( )
Returns
Title|null the "relevant" title - see Skin::getRelevantTitle

Definition at line 76 of file SkinComponentRegistryContext.php.

References getTitle().

◆ getTitle()

MediaWiki\Skin\SkinComponentRegistryContext::getTitle ( )

Returns the Title object for the component.

Returns
Title

Implements MediaWiki\Skin\ComponentRegistryContext.

Definition at line 69 of file SkinComponentRegistryContext.php.

◆ getUser()

MediaWiki\Skin\SkinComponentRegistryContext::getUser ( )
Returns
User

Definition at line 90 of file SkinComponentRegistryContext.php.

◆ getWikiPage()

MediaWiki\Skin\SkinComponentRegistryContext::getWikiPage ( )
Returns
WikiPage

Definition at line 118 of file SkinComponentRegistryContext.php.

◆ makeFooterIcon()

MediaWiki\Skin\SkinComponentRegistryContext::makeFooterIcon (   $icon,
  $withImage = 'withImage' 
)

Renders a $wgFooterIcons icon according to the method's arguments It exists to support skins overriding the method in MediaWiki 1.40 (overriding the method is now deprecated) It can be removed in 1.41.

Stability: unstable
Parameters
array$iconThe icon to build the html for, see $wgFooterIcons for the format of this array.
bool | string$withImageWhether to use the icon's image or output a text-only footericon.
Access: internal
Returns
string HTML

Definition at line 252 of file SkinComponentRegistryContext.php.

◆ runHook()

MediaWiki\Skin\SkinComponentRegistryContext::runHook ( string  $methodName,
array  $args 
)

Run a hook.

Parameters
string$methodName
array$args

Definition at line 128 of file SkinComponentRegistryContext.php.

References $args.


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