BaseTemplate class for the 'apioutput' skin. More...
Public Member Functions | |
| execute () | |
| Main function, used by classes that subclass QuickTemplate to show the actual HTML output. | |
| 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. | |
 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,... $params) | |
| Get a Message object with its context set. | |
| 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) | |
| msgWiki ( $str) | |
| 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) | |
Additional Inherited Members | |
| Public Attributes inherited from QuickTemplate | |
| array | $data |
| 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 inherited from QuickTemplate | |
| $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 | ( | ) |
Create an array of personal tools 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. This is in reality the same list as already stored in personal_urls however it is reformatted so that you can just pass the individual items to makeListItem instead of hardcoding the element creation boilerplate.
- Returns
- array
Reimplemented from BaseTemplate.
Definition at line 54 of file SkinApiTemplate.php.
◆ getSidebar()
| SkinApiTemplate::getSidebar | ( | $options = [] | ) |
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:
- includes/skins/SkinApiTemplate.php
