SkinApi Class Reference
SkinTemplate class for API output. More...
Inheritance diagram for SkinApi:
Collaboration diagram for SkinApi:
Public Attributes | |
| $skinname = 'apioutput' | |
 Public Attributes inherited from SkinTemplate | |
| $loggedin | |
| string | $template |
| For QuickTemplate, the name of the subclass which will actually fill the template. More... | |
| $thispage | |
| $thisquery | |
| $titletxt | |
| $username | |
| $userpage | |
| $userpageUrlDetails | |
Additional Inherited Members | |
| Public Member Functions inherited from SkinMustache | |
| generateHTML () | |
Subclasses not wishing to use the QuickTemplate render method can rewrite this method, for example to use TemplateParser::processTemplate.
| |
| getTemplateData () | |
| @inheritDoc More... | |
| Public Member Functions inherited from SkinTemplate | |
| getCategoryLinks () | |
| Extends category links with Skin::getAfterPortlet functionality. More... | |
| getStructuredPersonalTools () | |
| Get personal tools for the user. More... | |
| makePersonalToolsList ( $personalTools=null, $options=[]) | |
| Get the HTML for the personal tools list. More... | |
| makeSearchButton ( $mode, $attrs=[]) | |
| makeSearchInput ( $attrs=[]) | |
| outputPage () | |
| Initialize various variables and generate the template @stable to override. More... | |
| tabAction ( $title, $message, $selected, $query='', $checkEdit=false) | |
| Builds an array with tab definition. More... | |
| Public Member Functions inherited from Skin | |
| __construct ( $options=null) | |
| addToSidebar (&$bar, $message) | |
| Add content from a sidebar system message Currently only used for MediaWiki:Sidebar (but may be used by Extensions) More... | |
| addToSidebarPlain (&$bar, $text) | |
| Add content from plain text. More... | |
| bottomScripts ( $triggerWarnings=true) | |
| This gets called shortly before the "</body>" tag. More... | |
| buildSidebar () | |
| Build an array that represents the sidebar(s), the navigation bar among them. More... | |
| doEditSectionLink (Title $nt, $section, $sectionTitle, Language $lang) | |
| Create a section edit link. More... | |
| editUrlOptions () | |
| Return URL options for the 'edit page' link. More... | |
| footerLink ( $desc, $page) | |
| Given a pair of message keys for link and text label, return an HTML link for use in the footer. More... | |
| getAfterPortlet (string $name) | |
| Allows extensions to hook into known portlets and add stuff to them. More... | |
| getCategories () | |
| getCopyright ( $type='detect') | |
| getDefaultModules () | |
| Defines the ResourceLoader modules that should be added to the skin It is recommended that skins wishing to override call parent::getDefaultModules() and substitute out any modules they wish to change by using a key to look them up. More... | |
| getFooterIcons () | |
| Get template representation of the footer. More... | |
| getHtmlElementAttributes () | |
| Return values for <html> element. More... | |
| getLanguages () | |
| Generates array of language links for the current page. More... | |
| getNewtalks () | |
| Gets new talk page messages for the current user and returns an appropriate alert message (or an empty string if there are no messages) More... | |
| getOptions () | |
| Returns skin options Recommended to use SkinFactory::getSkinOptions instead. More... | |
| getPageClasses ( $title) | |
| TODO: document. More... | |
| getPersonalToolsForMakeListItem ( $urls, $applyClassesToListItems=false) | |
| Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate. More... | |
| getRelevantTitle () | |
| Return the "relevant" title. More... | |
| getRelevantUser () | |
| Return the "relevant" user. More... | |
| getSiteNotice () | |
| getSkinName () | |
| getUndeleteLink () | |
| initPage (OutputPage $out) | |
| isResponsive () | |
| Indicates if this skin is responsive. More... | |
| logoText ( $align='') | |
| makeFooterIcon ( $icon, $withImage='withImage') | |
| Renders a $wgFooterIcons icon according to the method's arguments. More... | |
| makeLink ( $key, $item, $linkOptions=[]) | |
| 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... More... | |
| makeListItem ( $key, $item, $options=[]) | |
| Generates a list item for a navigation, portlet, portal, sidebar... More... | |
| makeToolbox ( $navUrls, $feedUrls) | |
| Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate. More... | |
| mapInterwikiToLanguage ( $code) | |
| Allows correcting the language of interlanguage links which, mostly due to legacy reasons, do not always match the standards compliant language tag. More... | |
| prepareSubtitle (bool $withContainer=true) | |
| Prepare the subtitle of the page for output in the skin if one has been set. More... | |
| printSource () | |
| Text with the permalink to the source page, usually shown on the footer of a printed page. More... | |
| setRelevantTitle ( $t) | |
| setRelevantUser (?UserIdentity $u) | |
| showEmailUser ( $id) | |
| supportsMenu (string $menu) | |
| Does the skin support the named menu? More... | |
| Public Member Functions inherited from ContextSource | |
| canUseWikiPage () | |
| Check whether a WikiPage object can be get with getWikiPage(). More... | |
| exportSession () | |
| Export the resolved user IP, HTTP headers, user ID, and session ID. More... | |
| getActionName () | |
| Get the action name for the current web request. More... | |
| getAuthority () | |
| getConfig () | |
| getContext () | |
| Get the base IContextSource object. More... | |
| getCsrfTokenSet () | |
| Get a repository to obtain and match CSRF tokens. More... | |
| getLanguage () | |
| getOutput () | |
| getRequest () | |
| getSkin () | |
| getTiming () | |
| getTitle () | |
| getUser () | |
| getWikiPage () | |
| Get the WikiPage object. More... | |
| msg ( $key,... $params) | |
| Get a Message object with context set Parameters are the same as wfMessage() More... | |
| setContext (IContextSource $context) | |
| Static Public Member Functions inherited from SkinTemplate | |
| static | makeSearchButtonInternal ( $mode, $searchData, $attrs=[]) |
| Static Public Member Functions inherited from Skin | |
| static | getPortletLinkOptions (RL\Context $context) |
| Returns skin options for portlet links, used by addPortletLink. More... | |
| static | getVersion () |
| Get the current major version of Skin. More... | |
| static | makeInternalOrExternalUrl ( $name) |
| If url string starts with http, consider as external URL, else internal. More... | |
| static | makeMainPageUrl ( $urlaction='') |
| static | makeSpecialUrl ( $name, $urlaction='', $proto=null) |
| Make a URL for a Special Page using the given query and protocol. More... | |
| static | makeSpecialUrlSubpage ( $name, $subpage, $urlaction='') |
| static | normalizeKey ( $key) |
| Normalize a skin preference value to a form that can be loaded. More... | |
| Protected Member Functions inherited from SkinMustache | |
| getTemplateParser () | |
| Get the template parser, it will be lazily created if not already set. More... | |
| Protected Member Functions inherited from SkinTemplate | |
| buildContentNavigationUrls () | |
| Wrapper for private buildContentNavigationUrlsInternal. More... | |
| buildCreateAccountData ( $returnto) | |
| Build "Create Account" link data. More... | |
| buildLoginData ( $returnto, $useCombinedLoginLink) | |
| Build "Login" link. More... | |
| buildLogoutLinkData () | |
| Build data required for "Logout" link. More... | |
| buildPersonalPageItem ( $id='pt-userpage') | |
| Build a user page link data. More... | |
| buildPersonalUrls (bool $includeNotifications=true) | |
| Build array of urls for personal toolbar. More... | |
| getNameSpaceKey () | |
| Generate strings used for xml 'id' names. More... | |
| getReturnToParam () | |
| Builds query params for the page to return to, used when building links. More... | |
| injectLegacyMenusIntoPersonalTools (array $contentNavigation) | |
| Insert legacy menu items from content navigation into the personal toolbar. More... | |
| prepareQuickTemplate () | |
| initialize various variables and generate the template More... | |
| runOnSkinTemplateNavigationHooks (SkinTemplate $skin, &$content_navigation) | |
| Run hooks relating to navigation menu data. More... | |
| setupTemplate ( $classname) | |
| Create the template engine object; we feed it a bunch of data and eventually it spits out some HTML. More... | |
| setupTemplateContext () | |
| Setup class properties that are necessary prior to calling setupTemplateForOutput. More... | |
| setupTemplateForOutput () | |
| useCombinedLoginLink () | |
| Returns if a combined login/signup link will be used. More... | |
| Protected Member Functions inherited from Skin | |
| afterContentHook () | |
| This runs a hook to allow extensions placing their stuff after content and article metadata (e.g. More... | |
| buildFeedUrls () | |
| Build data structure representing syndication links. More... | |
| buildNavUrls () | |
| Build array of common navigation links. More... | |
| getAction () | |
| getComponent (string $name) | |
| getIndicatorsData ( $indicators) | |
| Return an array of indicator data. More... | |
| getJsConfigVars () | |
| Returns array of config variables that should be added only to this skin for use in JavaScript. More... | |
| getPortletData (string $name, array $items) | |
| lastModified () | |
| Get the timestamp of the latest revision, formatted in user language. More... | |
| prepareUndeleteLink () | |
| Prepare undelete link for output in page. More... | |
| prepareUserLanguageAttributes () | |
| Prepare user language attribute links. More... | |
| wrapHTML ( $title, $html) | |
| Wrap the body text with language information and identifiable element. More... | |
| Static Protected Member Functions inherited from Skin | |
| static | makeKnownUrlDetails ( $name, $urlaction='') |
| Make URL details where the article exists (or at least it's convenient to think so) More... | |
| static | makeUrlDetails ( $name, $urlaction='') |
| these return an array with the 'href' and boolean 'exists' More... | |
| Protected Attributes inherited from Skin | |
| $mRelevantTitle = null | |
| array | $options = [] |
| Skin options passed into constructor. More... | |
| string null | $skinname = null |
| const | VERSION_MAJOR = 1 |
| The current major version of the skin specification. More... | |
Detailed Description
Member Data Documentation
◆ $skinname
| SkinApi::$skinname = 'apioutput' |
Definition at line 32 of file SkinApi.php.
The documentation for this class was generated from the following file:
- includes/skins/SkinApi.php
