MediaWiki  master
SkinApiTemplate Class Reference

BaseTemplate class for the 'apioutput' skin. More...

Inheritance diagram for SkinApiTemplate:
Collaboration diagram for SkinApiTemplate:

Public Member Functions

 execute ()
 Main function, used by classes that subclass QuickTemplate to show the actual HTML output. More...
 
 getPersonalTools ()
 
 getToolbox ()
 Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate. More...
 
- Public Member Functions inherited from 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. More...
 
 getMsg ( $name,... $params)
 Get a Message object with its context set. More...
 
 getTrail ()
 Get the basic end-page trail including bottomscripts, reporttime, and debug stuff. More...
 
 makeListItem ( $key, $item, $options=[])
 
 msg ( $str)
 
 msgWiki ( $str)
 
- 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 More...
 
 get ( $name, $default=null)
 Gets the template data requested. More...
 
 getHTML ()
 Fetch the output of a QuickTemplate and return it. More...
 
 getSkin ()
 Get the Skin object related to this object. More...
 
 html ( $str)
 
 set ( $name, $value)
 Sets the value $value to $name. More...
 

Protected Member Functions

 getSidebar ( $options=[])
 PhanTypeMismatchDimAssignment. More...
 
- Protected Member Functions inherited from BaseTemplate
 getAfterPortlet ( $name)
 Allows extensions to hook into known portlets and add stuff to them. More...
 
 getClear ()
 Get a div with the core visualClear class, for clearing floats. More...
 
 getFooter ( $iconStyle='icononly', $linkStyle='flat')
 Renderer for getFooterIcons and getFooterLinks. More...
 
 getFooterIcons ( $option=null)
 Returns an array of footer icons filtered down by options relevant to how the skin wishes to display them. More...
 
 getFooterLinks ( $option=null)
 Returns an array of footerlinks trimmed down to only those footer links that are valid. More...
 
 makeLink ( $key, $item, $options=[])
 
 makeSearchButton ( $mode, $attrs=[])
 
 makeSearchInput ( $attrs=[])
 
 printTrail ()
 Output getTrail. More...
 
 renderAfterPortlet ( $name)
 
- 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

BaseTemplate class for the 'apioutput' skin.

Since
1.25

Definition at line 31 of file SkinApiTemplate.php.

Member Function Documentation

◆ execute()

SkinApiTemplate::execute ( )

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

Reimplemented from QuickTemplate.

Definition at line 33 of file SkinApiTemplate.php.

References QuickTemplate\html(), and BaseTemplate\printTrail().

◆ getPersonalTools()

SkinApiTemplate::getPersonalTools ( )
Deprecated:
since 1.35 use Skin::getPersonalToolsForMakeListItem
Returns
array

Reimplemented from BaseTemplate.

Definition at line 54 of file SkinApiTemplate.php.

◆ getSidebar()

SkinApiTemplate::getSidebar (   $options = [])
protected

PhanTypeMismatchDimAssignment.

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

Reimplemented from BaseTemplate.

Definition at line 58 of file SkinApiTemplate.php.

◆ getToolbox()

SkinApiTemplate::getToolbox ( )

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

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

Returns
array

Reimplemented from BaseTemplate.

Definition at line 50 of file SkinApiTemplate.php.


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