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. | |
| $thispage | |
| $thisquery | |
| $titletxt | |
| $username | |
| $userpage | |
| $userpageUrlDetails | |
| Public Attributes inherited from Skin | |
| string | $stylename = null |
| Stylesheets set to use. | |
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 () | |
Subclasses may extend this method to add additional template data.The data keys should be valid English words. Compound words should be hypenated except if they are normally written as one word. Each key should be prefixed with a type hint, this may be enforced by the class PHPUnit test.Plain strings are prefixed with 'html-', plain arrays with 'array-' and complex array data with 'data-'. 'is-' and 'has-' prefixes can be used for boolean variables. Messages are prefixed with 'msg-', followed by their message key. All messages specified in the skin option 'messages' will be available under 'msg-MESSAGE-NAME'.
| |
| Public Member Functions inherited from SkinTemplate | |
| getPersonalToolsList () | |
| Get the HTML for the p-personal list. | |
| getStructuredPersonalTools () | |
| Get personal tools for the user. | |
| makePersonalToolsList ( $personalTools=null, $options=[]) | |
| Get the HTML for the personal tools list Please ensure setupTemplateContext is called before calling this method. | |
| outputPage () | |
| Initialize various variables and generate the template. | |
| tabAction ( $title, $message, $selected, $query='', $checkEdit=false) | |
| Builds an array with tab definition. | |
| Public Member Functions inherited from Skin | |
| __construct ( $options=null) | |
| aboutLink () | |
| Gets the link to the wiki's about page. | |
| addToSidebar (&$bar, $message) | |
| Add content from a sidebar system message Currently only used for MediaWiki:Sidebar (but may be used by Extensions) | |
| addToSidebarPlain (&$bar, $text) | |
| Add content from plain text. | |
| bottomScripts () | |
| This gets called shortly before the "</body>" tag. | |
| buildSidebar () | |
| Build an array that represents the sidebar(s), the navigation bar among them. | |
| disclaimerLink () | |
| Gets the link to the wiki's general disclaimers page. | |
| doEditSectionLink (Title $nt, $section, $tooltip, Language $lang) | |
| Create a section edit link. | |
| editUrlOptions () | |
| Return URL options for the 'edit page' link. | |
| footerLink ( $desc, $page) | |
| Given a pair of message keys for link and text label, return an HTML link for use in the footer. | |
| getAfterPortlet (string $name) | |
| Allows extensions to hook into known portlets and add stuff to them. | |
| getCategories () | |
| getCategoryLinks () | |
| 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. | |
| getHtmlElementAttributes () | |
| Return values for <html> element. | |
| getIndicatorsHTML ( $indicators) | |
| 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. | |
| getLanguages () | |
| Generates array of language links for the current page. | |
| 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) | |
| getPageClasses ( $title) | |
| TODO: document. | |
| getPersonalToolsForMakeListItem ( $urls, $applyClassesToListItems=false) | |
| Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate. | |
| getRelevantTitle () | |
| Return the "relevant" title. | |
| getRelevantUser () | |
| Return the "relevant" user. | |
| getSearchPageTitle () | |
| getSiteFooterLinks () | |
| Gets the link to the wiki's privacy policy, about page, and disclaimer page. | |
| getSiteNotice () | |
| getSkinName () | |
| getSkinStylePath ( $name) | |
| Return a fully resolved style path URL to images or styles stored in the current skin's folder. | |
| getUndeleteLink () | |
| initPage (OutputPage $out) | |
| isResponsive () | |
| Indicates if this skin is responsive. | |
| logoText ( $align='') | |
| mainPageLink () | |
| Gets the link to the wiki's main page. | |
| makeFooterIcon ( $icon, $withImage='withImage') | |
| Renders a $wgFooterIcons icon according to the method's arguments. | |
| 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... | |
| makeListItem ( $key, $item, $options=[]) | |
| Generates a list item for a navigation, portlet, portal, sidebar... list. | |
| makeSearchButton ( $mode, $attrs=[]) | |
| makeSearchInput ( $attrs=[]) | |
| makeToolbox ( $navUrls, $feedUrls) | |
| Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate. | |
| mapInterwikiToLanguage ( $code) | |
| Allows correcting the language of interlanguage links which, mostly due to legacy reasons, do not always match the standards compliant language tag. | |
| prepareSubtitle () | |
| Prepare the subtitle of the page for output in the skin if one has been set. | |
| printSource () | |
| Text with the permalink to the source page, usually shown on the footer of a printed page. | |
| privacyLink () | |
| Gets the link to the wiki's privacy policy page. | |
| setRelevantTitle ( $t) | |
| setRelevantUser (?UserIdentity $u) | |
| setSearchPageTitle (Title $title) | |
| showEmailUser ( $id) | |
| subPageSubtitle ( $out) | |
| Public Member Functions inherited from ContextSource | |
| canUseWikiPage () | |
| Check whether a WikiPage object can be get with getWikiPage(). | |
| exportSession () | |
| Export the resolved user IP, HTTP headers, user ID, and session ID. | |
| getAuthority () | |
| getConfig () | |
| getContext () | |
| Get the base IContextSource object. | |
| getCsrfTokenSet () | |
| Get a repository to obtain and match CSRF tokens. | |
| getLanguage () | |
| getOutput () | |
| getRequest () | |
| getSkin () | |
| getStats () | |
| getTiming () | |
| getTitle () | |
| getUser () | |
| getWikiPage () | |
| Get the WikiPage object. | |
| msg ( $key,... $params) | |
| Get a Message object with context set Parameters are the same as wfMessage() | |
| setContext (IContextSource $context) | |
| Static Public Member Functions inherited from Skin | |
| static | checkTitle (&$title, $name) |
| make sure we have some title to operate on | |
| static | getAllowedSkins () |
| Fetch the list of user-selectable skins in regards to $wgSkipSkins. | |
| static | getSkinNames () |
| Fetch the set of available skins. | |
| static | getVersion () |
| Get the current major version of Skin. | |
| static | makeInternalOrExternalUrl ( $name) |
| If url string starts with http, consider as external URL, else internal. | |
| static | makeMainPageUrl ( $urlaction='') |
| static | makeSpecialUrl ( $name, $urlaction='', $proto=null) |
| Make a URL for a Special Page using the given query and protocol. | |
| static | makeSpecialUrlSubpage ( $name, $subpage, $urlaction='') |
| static | makeUrl ( $name, $urlaction='') |
| static | makeVariablesScript ( $data, $nonce=null) |
| static | normalizeKey ( $key) |
| Normalize a skin preference value to a form that can be loaded. | |
| Protected Member Functions inherited from SkinMustache | |
| getTemplateParser () | |
| Get the template parser, it will be lazily created if not already set. | |
| Protected Member Functions inherited from SkinTemplate | |
| buildContentNavigationUrls () | |
| a structured array of links usually used for the tabs in a skin | |
| buildCreateAccountData ( $returnto) | |
| Build "Create Account" link. | |
| buildLoginData ( $returnto, $useCombinedLoginLink) | |
| Build "Login" link. | |
| buildLogoutLinkData () | |
| Build data required for "Logout" link. | |
| buildPersonalPageItem ( $id='pt-userpage') | |
| Build a personal page link. | |
| buildPersonalUrls (bool $includeNotifications=true) | |
| build array of urls for personal toolbar Please ensure setupTemplateContext is called before calling this method. | |
| getFooterIcons () | |
| Get template representation of the footer. | |
| getJsConfigVars () | |
| Returns array of config variables that should be added only to this skin for use in JavaScript. | |
| getNameSpaceKey () | |
| Generate strings used for xml 'id' names. | |
| getPortletData ( $name, array $items) | |
| getReturnToParam () | |
| Builds query params for the page to return to, used when building links. | |
| injectLegacyMenusIntoPersonalTools (array $contentNavigation) | |
| Insert legacy menu items from content navigation into the personal toolbar. | |
| prepareQuickTemplate () | |
| initialize various variables and generate the template | |
| prepareUndeleteLink () | |
| Prepare undelete link for output in page. | |
| prepareUserLanguageAttributes () | |
| Prepare user language attribute links. | |
| runOnSkinTemplateNavigationHooks (SkinTemplate $skin, &$content_navigation) | |
| Run hooks relating to navigation menu data. | |
| setupTemplate ( $classname) | |
| Create the template engine object; we feed it a bunch of data and eventually it spits out some HTML. | |
| setupTemplateContext () | |
| Setup class properties that are necessary prior to calling setupTemplateForOutput. | |
| setupTemplateForOutput () | |
| useCombinedLoginLink () | |
| Returns if a combined login/signup link will be used. | |
| wrapHTML ( $title, $html) | |
| Wrap the body text with language information and identifiable element. | |
| Protected Member Functions inherited from Skin | |
| afterContentHook () | |
| This runs a hook to allow extensions placing their stuff after content and article metadata (e.g. | |
| buildFeedUrls () | |
| Build data structure representing syndication links. | |
| buildNavUrls () | |
| Build array of common navigation links. | |
| drawCategoryBrowser ( $tree) | |
| Render the array as a series of links. | |
| getCopyrightIcon () | |
| getFooterLinks () | |
| Get template representation of the footer containing site footer links as well as standard footer links. | |
| getIndicatorsData ( $indicators) | |
| Return an array of indicator data. | |
| getLogo () | |
| URL to the default square logo (1x key) | |
| getPoweredBy () | |
| Gets the powered by MediaWiki icon. | |
| getSearchLink () | |
| lastModified () | |
| Get the timestamp of the latest revision, formatted in user language. | |
| preloadExistence () | |
| Preload the existence of three commonly-requested pages in a single query. | |
| 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) | |
| static | makeUrlDetails ( $name, $urlaction='') |
| these return an array with the 'href' and boolean 'exists' | |
| Protected Attributes inherited from SkinTemplate | |
| $action | |
| Protected Attributes inherited from Skin | |
| $mRelevantTitle = null | |
| array | $options = [] |
| Skin options passed into constructor. | |
| string null | $skinname = null |
| const | VERSION_MAJOR = 1 |
| The current major version of the skin specification. | |
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
