- Generated on Sat Apr 6 2024 00:08:36 for MediaWiki by
1.9.8
|
MediaWiki REL1_35
|
Some internal bits split of from Skin.php. More...
Static Public Member Functions | |
| static | accesskey ( $name) |
| Given the id of an interface element, constructs the appropriate accesskey attribute from the system messages. | |
| static | blockLink ( $userId, $userText) |
| static | buildRollbackLink ( $rev, IContextSource $context=null, $editCount=false) |
| Build a raw rollback link, useful for collections of "tool" links. | |
| static | commentBlock ( $comment, $title=null, $local=false, $wikiId=null, $useParentheses=true) |
| Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty string. | |
| static | emailLink ( $userId, $userText) |
| static | formatComment ( $comment, $title=null, $local=false, $wikiId=null) |
| This function is called by all recent changes variants, by the page history, and by the user contributions list. | |
| static | formatHiddenCategories ( $hiddencats) |
| Returns HTML for the "hidden categories on this page" list. | |
| static | formatLinksInComment ( $comment, $title=null, $local=false, $wikiId=null) |
| Formats wiki links and media links in text; all other wiki formatting is ignored. | |
| static | formatRevisionSize ( $size) |
| static | generateRollback ( $rev, IContextSource $context=null, $options=[ 'verify']) |
| Generate a rollback link for a given revision. | |
| static | generateTOC ( $tree, Language $lang=null) |
| Generate a table of contents from a section tree. | |
| static | getInvalidTitleDescription (IContextSource $context, $namespace, $title) |
| Get a message saying that an invalid title was encountered. | |
| static | getRevDeleteLink (User $user, $rev, LinkTarget $title) |
| Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the settings on the revision. | |
| static | getRollbackEditCount ( $rev, $verify) |
| This function will return the number of revisions which a rollback would revert and, if $verify is set it will verify that a revision can be reverted (that the user isn't the only contributor and the revision we might rollback to isn't deleted). | |
| static | link ( $target, $html=null, $customAttribs=[], $query=[], $options=[]) |
| This function returns an HTML link to the given target. | |
| static | linkKnown ( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known']) |
| Identical to link(), except $options defaults to 'known'. | |
| static | makeBrokenImageLinkObj ( $title, $label='', $query='', $unused1='', $unused2='', $time=false) |
| Make a "broken" link to an image. | |
| static | makeCommentLink (LinkTarget $linkTarget, $text, $wikiId=null, $options=[]) |
| Generates a link to the given LinkTarget. | |
| static | makeExternalImage ( $url, $alt='') |
| Return the code for images which were added via external links, via Parser::maybeMakeExternalImage(). | |
| static | makeExternalLink ( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null) |
| Make an external link. | |
| static | makeHeadline ( $level, $attribs, $anchor, $html, $link, $fallbackAnchor=false) |
| Create a headline for content. | |
| static | makeImageLink (Parser $parser, LinkTarget $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query="", $widthOption=null) |
| Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in the page. | |
| static | makeMediaLinkFile (LinkTarget $title, $file, $html='') |
| Create a direct link to a given uploaded file. | |
| static | makeMediaLinkObj ( $title, $html='', $time=false) |
| Create a direct link to a given uploaded file. | |
| static | makeSelfLinkObj ( $nt, $html='', $query='', $trail='', $prefix='') |
| Make appropriate markup for a link to the current article. | |
| static | makeThumbLink2 (LinkTarget $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query="", ?Parser $parser=null) |
| static | makeThumbLinkObj (LinkTarget $title, $file, $label='', $alt='', $align='right', $params=[], $framed=false, $manualthumb="") |
| Make HTML for a thumbnail including image, border and caption. | |
| static | normaliseSpecialPage (LinkTarget $target) |
| static | normalizeSubpageLink ( $contextTitle, $target, &$text) |
| static | processResponsiveImages ( $file, $thumb, $hp) |
| Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable. | |
| static | revComment ( $rev, $local=false, $isPublic=false, $useParentheses=true) |
| Wrap and format the given revision's comment block, if the current user is allowed to view it. | |
| static | revDeleteLink ( $query=[], $restricted=false, $delete=true) |
| Creates a (show/hide) link for deleting revisions/log entries. | |
| static | revDeleteLinkDisabled ( $delete=true) |
| Creates a dead (show/hide) link for deleting revisions/log entries. | |
| static | revUserLink ( $rev, $isPublic=false) |
| Generate a user link if the current user is allowed to view it. | |
| static | revUserTools ( $rev, $isPublic=false, $useParentheses=true) |
| Generate a user tool link cluster if the current user is allowed to view it. | |
| static | specialLink ( $name, $key='') |
| Make a link to a special page given its name and, optionally, a message key from the link text. | |
| static | splitTrail ( $trail) |
| Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array. | |
| static | titleAttrib ( $name, $options=null, array $msgParams=[]) |
| Given the id of an interface element, constructs the appropriate title attribute from the system messages. | |
| static | tocIndent () |
| Add another level to the Table of Contents. | |
| static | tocLine ( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false) |
| parameter level defines if we are on an indentation level | |
| static | tocLineEnd () |
| End a Table Of Contents line. | |
| static | tocList ( $toc, Language $lang=null) |
| Wraps the TOC in a div with ARIA navigation role and provides the hide/collapse JavaScript. | |
| static | tocUnindent ( $level) |
| Finish one or more sublevels on the Table of Contents. | |
| static | tooltip ( $name, $options=null) |
| Returns raw bits of HTML, use titleAttrib() | |
| static | tooltipAndAccesskeyAttribs ( $name, array $msgParams=[], $options=null) |
| Returns the attributes for the tooltip and access key. | |
| static | userLink ( $userId, $userName, $altUserName=false) |
| Make user link (or user contributions for unregistered users) | |
| static | userTalkLink ( $userId, $userText) |
| static | userToolLinks ( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null, $useParentheses=true) |
| Generate standard user tool links (talk, contributions, block link, etc.) | |
| static | userToolLinksRedContribs ( $userId, $userText, $edits=null, $useParentheses=true) |
| Alias for userToolLinks( $userId, $userText, true );. | |
Public Attributes | |
| const | TOOL_LINKS_EMAIL = 2 |
| const | TOOL_LINKS_NOBLOCK = 1 |
| Flags for userToolLinks() | |
Static Public Attributes | |
| static | $accesskeycache |
Static Protected Member Functions | |
| static | getUploadUrl ( $destFile, $query='') |
| Get the URL to upload a certain file. | |
Static Private Member Functions | |
| static | fnamePart ( $url) |
| Returns the filename part of an url. | |
| static | formatAutocomments ( $comment, $title=null, $local=false, $wikiId=null) |
| Converts autogenerated comments in edit summaries into section links. | |
| static | getImageLinkMTOParams ( $frameParams, $query='', $parser=null) |
| Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by the Parser. | |
Some internal bits split of from Skin.php.
These functions are used for primarily page content: links, embedded images, table of contents. Links are also used in the skin.
Definition at line 36 of file Linker.php.
|
static |
Given the id of an interface element, constructs the appropriate accesskey attribute from the system messages.
(Note, this is usually the id but isn't always, because sometimes the accesskey needs to go on a different element than the id, for reverse-compatibility, etc.)
| string | $name | Id of the element, minus prefixes. |
Definition at line 2168 of file Linker.php.
References wfMessage().
Referenced by DummyLinker\accesskey(), OOUIHTMLForm\getButtons(), EditPage\getEditButtons(), EditPage\getSummaryInputWidget(), HTMLFormField\getTooltipAndAccessKeyOOUI(), titleAttrib(), and tooltipAndAccesskeyAttribs().
|
static |
| int | $userId | |
| string | $userText | User name in database. |
Definition at line 1067 of file Linker.php.
References SpecialPage\getTitleFor(), link(), wfDebug(), and wfMessage().
Referenced by DummyLinker\blockLink(), and userToolLinks().
|
static |
Build a raw rollback link, useful for collections of "tool" links.
| RevisionRecord | Revision | $rev | (RevisionRecord allowed since 1.35, Revision deprecated since 1.35) |
| IContextSource | null | $context | Context to use or null for the main context. |
| int | false | $editCount | Number of edits that would be reverted |
Definition at line 2003 of file Linker.php.
References $title, $wgMiserMode, $wgShowRollbackEditCount, getRollbackEditCount(), link(), and wfDeprecated().
Referenced by DummyLinker\buildRollbackLink(), and generateRollback().
|
static |
Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty string.
| string | $comment | |
| LinkTarget | null | $title | LinkTarget object (to generate link to section in autocomment) or null |
| bool | $local | Whether section links should refer to local page |
| string | null | $wikiId | Id (as used by WikiMap) of the wiki to generate links to. For use with external changes. |
| bool | $useParentheses | Whether the comment is wrapped in parentheses |
Definition at line 1584 of file Linker.php.
References $title, formatComment(), and wfMessage().
Referenced by DummyLinker\commentBlock(), LogFormatter\getComment(), RevDelFileItem\getComment(), SpecialUndelete\getFileComment(), McrUndoAction\getFormFields(), RevDelLogItem\getHTML(), EditPage\getSummaryPreview(), ChangesList\insertComment(), and revComment().
|
static |
| int | $userId | |
| string | $userText | User name in database. |
Definition at line 1088 of file Linker.php.
References SpecialPage\getTitleFor(), link(), wfLogWarning(), and wfMessage().
Referenced by DummyLinker\emailLink(), and userToolLinks().
|
staticprivate |
Returns the filename part of an url.
Used as alternative text for external images.
| string | $url |
Definition at line 223 of file Linker.php.
Referenced by makeExternalImage().
|
staticprivate |
Converts autogenerated comments in edit summaries into section links.
The pattern for autogen comments is / * foo * /, which makes for some nasty regex. We look for all comments, match any text before and after the comment, add a separator where needed and format the comment itself with CSS Called by Linker::formatComment.
| string | $comment | Comment text |
| LinkTarget | null | $title | An optional LinkTarget object used to links to sections |
| bool | $local | Whether section links should refer to local page |
| string | null | $wikiId | Id of the wiki to link to (if not the local wiki), as used by WikiMap. |
Definition at line 1239 of file Linker.php.
References $title, $wgLang, makeCommentLink(), NS_MAIN, and wfMessage().
Referenced by formatComment().
|
static |
This function is called by all recent changes variants, by the page history, and by the user contributions list.
It is responsible for formatting edit summaries. It escapes any HTML in the summary, but adds some CSS to format auto-generated comments (from section editing) and formats [[wikilinks]].
| string | $comment | |
| LinkTarget | null | $title | LinkTarget object (to generate link to the section in autocomment) or null |
| bool | $local | Whether section links should refer to local page |
| string | null | $wikiId | Id (as used by WikiMap) of the wiki to generate links to. For use with external changes. |
Definition at line 1209 of file Linker.php.
References $title, formatAutocomments(), and formatLinksInComment().
Referenced by commentBlock(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryWatchlist\extractOutputData(), ApiQueryRevisionsBase\extractRevisionInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryUserContribs\extractRowInfo(), DummyLinker\formatComment(), FeedUtils\formatDiffRow(), ApiParse\formatSummary(), ImageListPager\formatValue(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ApiQueryImageInfo\getInfo(), RollbackAction\handleRollbackRequest(), ImageHistoryList\imageHistoryLine(), ApiQueryProtectedTitles\run(), and ApiComparePages\setVals().
|
static |
Returns HTML for the "hidden categories on this page" list.
| array | $hiddencats | Array of hidden categories from WikiPage::getHiddenCategories or similar |
Definition at line 2085 of file Linker.php.
References link(), and wfMessage().
Referenced by DummyLinker\formatHiddenCategories(), InfoAction\pageInfo(), and EditPage\showEditForm().
|
static |
Formats wiki links and media links in text; all other wiki formatting is ignored.
| string | $comment | Text to format links in. WARNING! Since the output of this function is html, $comment must be sanitized for use as html. You probably want to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling this function. |
| LinkTarget | null | $title | An optional LinkTarget object used to links to sections |
| bool | $local | Whether section links should refer to local page |
| string | null | $wikiId | Id of the wiki to link to (if not the local wiki), as used by WikiMap. |
Definition at line 1340 of file Linker.php.
References $title, StringUtils\escapeRegexReplacement(), makeCommentLink(), makeMediaLinkObj(), normalizeSubpageLink(), NS_FILE, NS_MEDIA, and splitTrail().
Referenced by formatComment(), and DummyLinker\formatLinksInComment().
|
static |
| int | $size |
Definition at line 1660 of file Linker.php.
References wfMessage().
Referenced by SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), DummyLinker\formatRevisionSize(), ContribsPager\formatRow(), ProtectedPagesPager\formatValue(), and HistoryPager\historyLine().
|
static |
Generate a rollback link for a given revision.
Currently it's the caller's responsibility to ensure that the revision is the top one. If it's not, of course, the user will get an error message.
If the calling page is called with the parameter &bot=1, all rollback links also get that parameter. It causes the edit itself and the rollback to be marked as "bot" edits. Bot edits are hidden by default from recent changes, so this allows sysops to combat a busy vandal without bothering other users.
If the option verify is set this function will return the link only in case the revision can be reverted. Please note that due to performance limitations it might be assumed that a user isn't the only contributor of a page while (s)he is, which will lead to useless rollback links. Furthermore this wont work if $wgShowRollbackEditCount is disabled, so this can only function as an additional check.
If the option noBrackets is set the rollback link wont be enclosed in "[]".
| RevisionRecord | Revision | $rev | (RevisionRecord allowed since 1.35, Revision deprecated since 1.35) |
| IContextSource | null | $context | Context to use or null for the main context. |
| array | $options |
Definition at line 1871 of file Linker.php.
References buildRollbackLink(), getRollbackEditCount(), and wfDeprecated().
Referenced by ContribsPager\formatRow(), DummyLinker\generateRollback(), HistoryPager\historyLine(), ChangesList\insertRollback(), and DifferenceEngine\showDiffPage().
|
static |
Generate a table of contents from a section tree.
| array[] | $tree | Return value of ParserOutput::getSections() |
| Language | null | $lang | Language for the toc title, defaults to user language |
Definition at line 1774 of file Linker.php.
References $lang, tocIndent(), tocLine(), tocLineEnd(), tocList(), and tocUnindent().
Referenced by DummyLinker\generateTOC(), and ApiHelp\getHelp().
|
staticprivate |
Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by the Parser.
| array | $frameParams | The frame parameters |
| string | $query | An optional query string to add to description page links |
| Parser | null | $parser |
Definition at line 453 of file Linker.php.
Referenced by makeImageLink(), and makeThumbLink2().
|
static |
Get a message saying that an invalid title was encountered.
This should be called after a method like Title::makeTitleSafe() returned a value indicating that the title object is invalid.
| IContextSource | $context | Context to use to get the messages |
| int | $namespace | Namespace number |
| string | $title | Text of the title, without the namespace part |
Definition at line 188 of file Linker.php.
References $title, MessageLocalizer\msg(), and NS_MAIN.
Referenced by SpecialFewestRevisions\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialMostLinked\formatResult(), SpecialMostLinkedCategories\formatResult(), SpecialMostLinkedTemplates\formatResult(), SpecialShortPages\formatResult(), SpecialUnwatchedPages\formatResult(), PageQueryPage\formatResult(), SpecialProtectedtitles\formatRow(), ProtectedPagesPager\formatValue(), DummyLinker\getInvalidTitleDescription(), and SpecialUndelete\showList().
|
static |
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the settings on the revision.
Will use forward-compatible revision ID in the Special:RevDelete link if possible, otherwise the timestamp-based ID which may break after undeletion.
| User | $user | |
| RevisionRecord | Revision | $rev | (RevisionRecord allowed since 1.35, Revision deprecated since 1.35) |
| LinkTarget | $title |
Definition at line 2205 of file Linker.php.
References $title, revDeleteLink(), revDeleteLinkDisabled(), and wfDeprecated().
Referenced by SpecialUndelete\diffHeader(), DeletedContribsPager\formatRevisionRow(), ContribsPager\formatRow(), DummyLinker\getRevDeleteLink(), DifferenceEngine\revisionDeleteLink(), Article\setOldSubtitle(), and SpecialUndelete\showRevision().
|
static |
This function will return the number of revisions which a rollback would revert and, if $verify is set it will verify that a revision can be reverted (that the user isn't the only contributor and the revision we might rollback to isn't deleted).
These checks can only function as an additional check as this function only checks against the last $wgShowRollbackEditCount edits.
Returns null if $wgShowRollbackEditCount is disabled or false if $verify is set and the user is the only contributor of the page.
| RevisionRecord | Revision | $rev | (RevisionRecord allowed since 1.35, Revision deprecated since 1.35) |
| bool | $verify | Try to verify that this revision can really be rolled back |
Definition at line 1926 of file Linker.php.
References $dbr, $res, $revQuery, $wgShowRollbackEditCount, DB_REPLICA, wfDeprecated(), and wfGetDB().
Referenced by buildRollbackLink(), generateRollback(), and DummyLinker\getRollbackEditCount().
|
staticprotected |
Get the URL to upload a certain file.
| LinkTarget | $destFile | LinkTarget object of the file to upload |
| string | $query | Urlencoded query string to prepend |
Definition at line 740 of file Linker.php.
References $wgUploadMissingFileUrl, $wgUploadNavigationUrl, SpecialPage\getTitleFor(), and wfAppendQuery().
Referenced by makeMediaLinkFile().
|
static |
This function returns an HTML link to the given target.
It serves a few purposes: 1) If $target is a LinkTarget, the correct URL to link to will be figured out automatically. 2) It automatically adds the usual classes for various types of link targets: "new" for red links, "stub" for short articles, etc. 3) It escapes all attribute values safely so there's no risk of XSS. 4) It provides a default tooltip if the target is a LinkTarget (the page name of the target). link() replaces the old functions in the makeLink() family.
| LinkTarget | $target | Can currently only be a LinkTarget, but this may change to support Images, literal URLs, etc. |
| string | null | $html | The HTML contents of the element, i.e., the link text. This is raw HTML and will not be escaped. If null, defaults to the prefixed text of the LinkTarget; or if the LinkTarget is just a fragment, the contents of the fragment. |
| array | $customAttribs | A key => value array of extra HTML attributes, such as title and class. (href is ignored.) Classes will be merged with the default classes, while other attributes will replace default attributes. All passed attribute values will be HTML-escaped. A false attribute value means to suppress that attribute. |
| array | $query | The query string to append to the URL you're linking to, in key => value array form. Query keys and values will be URL-encoded. |
| string | array | $options | String or array of strings: 'known': Page is known to exist, so don't check if it does. 'broken': Page is known not to exist, so don't check if it does. 'noclasses': Don't add any classes automatically (includes "new", "stub", "mw-redirect", "extiw"). Only use the class attribute provided, if any, so you get a simple blue link with no funny i- cons. 'forcearticlepath': Use the article path always, even with a querystring. Has compatibility issues on some setups, so avoid wherever possible. 'http': Force a full URL with http:// as the scheme. 'https': Force a full URL with https:// as the scheme. 'stubThreshold' => (int): Stub threshold to use when determining link classes. |
Definition at line 86 of file Linker.php.
References wfWarn().
Referenced by blockLink(), buildRollbackLink(), emailLink(), formatHiddenCategories(), DummyLinker\link(), linkKnown(), makeBrokenImageLinkObj(), makeCommentLink(), makeImageLink(), revDeleteLink(), userLink(), userTalkLink(), and userToolLinks().
|
static |
Identical to link(), except $options defaults to 'known'.
| LinkTarget | $target | |
| string | null | $html | |
| array | $customAttribs | |
| array | $query | |
| string | array | $options |
Definition at line 142 of file Linker.php.
References link().
Referenced by DummyLinker\linkKnown(), and specialLink().
|
static |
Make a "broken" link to an image.
| LinkTarget | $title | |
| string | $label | Link label (plain text) |
| string | $query | Query string |
| string | $unused1 | Unused parameter kept for b/c |
| string | $unused2 | Unused parameter kept for b/c |
| bool | $time | A file of a certain timestamp was requested |
Definition at line 684 of file Linker.php.
References $title, $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl, link(), wfCgiToArray(), and wfWarn().
Referenced by DummyLinker\makeBrokenImageLinkObj(), makeImageLink(), and makeThumbLink2().
|
static |
Generates a link to the given LinkTarget.
| LinkTarget | $linkTarget | |
| string | $text | |
| string | null | $wikiId | Id of the wiki to link to (if not the local wiki), as used by WikiMap. |
| string | string[] | $options | See the $options parameter in Linker::link. |
Definition at line 1461 of file Linker.php.
References MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getFragment(), MediaWiki\Linker\LinkTarget\getNamespace(), MediaWiki\Linker\LinkTarget\isExternal(), link(), and makeExternalLink().
Referenced by formatAutocomments(), formatLinksInComment(), and DummyLinker\makeCommentLink().
|
static |
Return the code for images which were added via external links, via Parser::maybeMakeExternalImage().
| string | $url | |
| string | $alt |
Definition at line 243 of file Linker.php.
References $success, fnamePart(), and wfDebug().
Referenced by DummyLinker\makeExternalImage(), and Parser\maybeMakeExternalImage().
|
static |
Make an external link.
| string | $url | URL to link to |
| -taint | $url | escapes_html |
| string | $text | Text of link |
| -taint | $text | escapes_html |
| bool | $escape | Do we escape the link text? |
| -taint | $escape | none |
| string | $linktype | Type of external link. Gets added to the classes |
| -taint | $linktype | escapes_html |
| array | $attribs | Array of extra attributes to |
| -taint | $attribs | escapes_html |
| LinkTarget | null | $title | LinkTarget object used for title specific link attributes |
| -taint | $title | none |
Definition at line 856 of file Linker.php.
References $success, $title, $wgTitle, and wfDebug().
Referenced by SpecialLinkSearch\formatResult(), AllMessagesTablePager\formatValue(), Skin\getCopyright(), SpecialVersion\getCreditsForExtension(), SpecialVersion\getExternalLibraries(), SpecialVersion\getParserFunctionHooks(), SpecialVersion\getParserTags(), Parser\handleExternalLinks(), ImagePage\imageDupes(), Parser\magicLinkCallback(), makeCommentLink(), DummyLinker\makeExternalLink(), WikiMap\makeForeignLink(), Parser\makeFreeExternalLink(), Article\showRedirectedFromHeader(), and ImagePage\uploadLinksBox().
|
static |
Create a headline for content.
| int | $level | The level of the headline (1-6) |
| string | $attribs | Any attributes for the headline, starting with a space and ending with '>' This must be at least '>' for no attribs |
| string | $anchor | The anchor to give the headline (the bit after the #) |
| string | $html | HTML for the text of the header |
| string | $link | HTML to add for the section edit link |
| string | bool | $fallbackAnchor | A second, optional anchor to give for backward compatibility (false to omit) |
Definition at line 1812 of file Linker.php.
References $fallback.
Referenced by Parser\finalizeHeadings(), DummyLinker\makeHeadline(), and ApiMain\modifyHelp().
|
static |
Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in the page.
| Parser | $parser | |
| LinkTarget | $title | LinkTarget object of the file (not the currently viewed page) |
| File | $file | File object, or false if it doesn't exist |
| array | $frameParams | Associative array of parameters external to the media handler. Boolean parameters are indicated by presence or absence, the value is arbitrary and will often be false. thumbnail If present, downscale and frame manualthumb Image name to use as a thumbnail, instead of automatic scaling framed Shows image in original size in a frame frameless Downscale but don't frame upright If present, tweak default sizes for portrait orientation upright_factor Fudge factor for "upright" tweak (default 0.75) border If present, show a border around the image align Horizontal alignment (left, right, center, none) valign Vertical alignment (baseline, sub, super, top, text-top, middle, bottom, text-bottom) alt Alternate text for image (i.e. alt attribute). Plain text. class HTML for image classes. Plain text. caption HTML for image caption. link-url URL to link to link-title LinkTarget object to link to link-target Value for the target attribute, only with link-url no-link Boolean, suppress description link targetlang (optional) Target language code, see Parser::getTargetLanguage() |
| array | $handlerParams | Associative array of media handler parameters, to be passed to transform(). Typical keys are "width" and "page". |
| string | bool | $time | Timestamp of the file, set as false for current |
| string | $query | Query params for desc url |
| int | null | $widthOption | Used by the parser to remember the user preference thumbnailsize |
Definition at line 299 of file Linker.php.
References $file, $res, $s, $title, $wgSVGMaxSize, $wgThumbLimits, $wgThumbUpright, Parser\getBadFileLookup(), User\getDefaultOption(), getImageLinkMTOParams(), Parser\getTargetLanguage(), Parser\getTitle(), link(), makeBrokenImageLinkObj(), makeThumbLink2(), processResponsiveImages(), and wfDebug().
Referenced by Parser\makeImage(), and DummyLinker\makeImageLink().
|
static |
Create a direct link to a given uploaded file.
This will make a broken link if $file is false.
Definition at line 788 of file Linker.php.
References $file, $title, getUploadUrl(), and wfDebug().
Referenced by Parser\handleInternalLinks2(), DummyLinker\makeMediaLinkFile(), and makeMediaLinkObj().
|
static |
Create a direct link to a given uploaded file.
| LinkTarget | $title | |
| string | $html | Pre-sanitized HTML |
| string | false | $time | MW timestamp of file creation time |
Definition at line 769 of file Linker.php.
References $title, and makeMediaLinkFile().
Referenced by formatLinksInComment(), SpecialMIMESearch\formatResult(), and DummyLinker\makeMediaLinkObj().
|
static |
Make appropriate markup for a link to the current article.
This is since MediaWiki 1.29.0 rendered as an tag without an href and with a class showing the link text. The calling sequence is the same as for the other make*LinkObj static functions, but $query is not used.
| LinkTarget | $nt | |
| string | $html | [optional] |
| string | $query | [optional] |
| string | $trail | [optional] |
| string | $prefix | [optional] |
Definition at line 164 of file Linker.php.
References splitTrail().
Referenced by Parser\handleInternalLinks2(), DummyLinker\makeSelfLinkObj(), and LinkHolderArray\replaceInternal().
|
static |
| LinkTarget | $title | |
| File | $file | |
| array | $frameParams | |
| array | $handlerParams | |
| bool | $time | |
| string | $query | |
| Parser | null | $parser |
Definition at line 520 of file Linker.php.
References $file, $s, $title, getImageLinkMTOParams(), makeBrokenImageLinkObj(), NS_FILE, processResponsiveImages(), wfAppendQuery(), and wfMessage().
Referenced by makeImageLink(), DummyLinker\makeThumbLink2(), and makeThumbLinkObj().
|
static |
Make HTML for a thumbnail including image, border and caption.
| LinkTarget | $title | |
| File | bool | $file | File object or false if it doesn't exist |
| string | $label | |
| string | $alt | |
| string | $align | |
| array | $params | |
| bool | $framed | |
| string | $manualthumb |
Definition at line 493 of file Linker.php.
References $file, $title, and makeThumbLink2().
Referenced by DummyLinker\makeThumbLinkObj(), and ImagePage\openShowImage().
|
static |
| LinkTarget | $target |
Definition at line 209 of file Linker.php.
References wfDeprecated().
|
static |
| LinkTarget | $contextTitle | |
| string | $target | |
| string | &$text |
Definition at line 1491 of file Linker.php.
Referenced by Parser\braceSubstitution(), formatLinksInComment(), Parser\handleInternalLinks2(), and DummyLinker\normalizeSubpageLink().
|
static |
Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.
| File | $file | |
| MediaTransformOutput | $thumb | |
| array | $hp | Image parameters |
Definition at line 649 of file Linker.php.
References $file, and $wgResponsiveImages.
Referenced by makeImageLink(), makeThumbLink2(), ImagePage\openShowImage(), DummyLinker\processResponsiveImages(), and TraditionalImageGallery\toHTML().
|
static |
Wrap and format the given revision's comment block, if the current user is allowed to view it.
| RevisionRecord | Revision | $rev | (RevisionRecord allowed since 1.35, Revision deprecated since 1.35) |
| bool | $local | Whether section links should refer to local page |
| bool | $isPublic | Show only if all users can see it |
| bool | $useParentheses | (optional) Wrap comments in parentheses where needed |
Definition at line 1615 of file Linker.php.
References commentBlock(), wfDeprecated(), and wfMessage().
Referenced by SpecialUndelete\diffHeader(), DeletedContribsPager\formatRevisionRow(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialNewpages\formatRow(), ContribsPager\formatRow(), ChangeTagsRevisionItem\getHTML(), RevDelRevisionItem\getHTML(), RevisionItem\getHTML(), HistoryPager\historyLine(), DummyLinker\revComment(), Article\setOldSubtitle(), and DifferenceEngine\showDiffPage().
|
static |
Creates a (show/hide) link for deleting revisions/log entries.
| array | $query | Query parameters to be passed to link() |
| bool | $restricted | Set to true to use a "<strong>" instead of a "<span>" |
| bool | $delete | Set to true to use (show/hide) rather than (show) |
Definition at line 2263 of file Linker.php.
References SpecialPage\getTitleFor(), link(), and wfMessage().
Referenced by SpecialUndelete\formatFileRow(), getRevDeleteLink(), LogEventsList\getShowHideLinks(), HistoryPager\historyLine(), ImageHistoryList\imageHistoryLine(), and DummyLinker\revDeleteLink().
|
static |
Creates a dead (show/hide) link for deleting revisions/log entries.
| bool | $delete | Set to true to use (show/hide) rather than (show) |
Definition at line 2285 of file Linker.php.
References wfMessage().
Referenced by SpecialUndelete\formatFileRow(), getRevDeleteLink(), LogEventsList\getShowHideLinks(), HistoryPager\historyLine(), ImageHistoryList\imageHistoryLine(), and DummyLinker\revDeleteLinkDisabled().
|
static |
Generate a user link if the current user is allowed to view it.
| RevisionRecord | Revision | $rev | (RevisionRecord allowed since 1.35, Revision deprecated since 1.35) |
| bool | $isPublic | Show only if all users can see it |
Definition at line 1111 of file Linker.php.
References userLink(), wfDeprecated(), and wfMessage().
Referenced by ChangeTagsRevisionItem\getHTML(), RevDelRevisionItem\getHTML(), RevisionItem\getHTML(), and DummyLinker\revUserLink().
|
static |
Generate a user tool link cluster if the current user is allowed to view it.
| RevisionRecord | Revision | $rev | (RevisionRecord allowed since 1.35, Revision deprecated since 1.35) |
| bool | $isPublic | Show only if all users can see it |
| bool | $useParentheses | (optional) Wrap comments in parentheses where needed |
Definition at line 1152 of file Linker.php.
References userLink(), userToolLinks(), wfDeprecated(), and wfMessage().
Referenced by SpecialUndelete\diffHeader(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialNewpages\formatRow(), RollbackAction\handleRollbackRequest(), HistoryPager\historyLine(), InfoAction\pageInfo(), DummyLinker\revUserTools(), Article\setOldSubtitle(), DifferenceEngine\showDiffPage(), and SpecialUndelete\showRevision().
|
static |
Make a link to a special page given its name and, optionally, a message key from the link text.
Usage example: Linker::specialLink( 'Recentchanges' )
| string | $name | |
| string | $key |
Definition at line 830 of file Linker.php.
References SpecialPage\getTitleFor(), linkKnown(), and wfMessage().
Referenced by DummyLinker\specialLink().
|
static |
Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array.
| string | $trail |
Definition at line 1833 of file Linker.php.
Referenced by formatLinksInComment(), Parser\handleExternalLinks(), LinkHolderArray\makeHolder(), Parser\makeKnownLinkHolder(), makeSelfLinkObj(), and DummyLinker\splitTrail().
|
static |
Given the id of an interface element, constructs the appropriate title attribute from the system messages.
(Note, this is usually the id but isn't always, because sometimes the accesskey needs to go on a different element than the id, for reverse-compatibility, etc.)
| string | $name | Id of the element, minus prefixes. |
| string | array | null | $options | Null, string or array with some of the following options:
|
| array | $msgParams | Parameters to pass to the message |
Definition at line 2120 of file Linker.php.
References accesskey(), and wfMessage().
Referenced by OOUIHTMLForm\getButtons(), EditPage\getCheckboxesWidget(), EditPage\getEditButtons(), EditPage\getSummaryInputWidget(), HTMLFormField\getTooltipAndAccessKeyOOUI(), Skin\makeLink(), DifferenceEngine\showDiffPage(), EditPage\showEditForm(), DummyLinker\titleAttrib(), tooltip(), and tooltipAndAccesskeyAttribs().
|
static |
Add another level to the Table of Contents.
Definition at line 1675 of file Linker.php.
Referenced by Parser\finalizeHeadings(), generateTOC(), SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocIndent().
|
static |
parameter level defines if we are on an indentation level
| string | $anchor | |
| string | $tocline | |
| string | $tocnumber | |
| string | $level | |
| string | bool | $sectionIndex |
Definition at line 1701 of file Linker.php.
Referenced by Parser\finalizeHeadings(), generateTOC(), SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocLine().
|
static |
End a Table Of Contents line.
tocUnindent() will be used instead if we're ending a line below the new level.
Definition at line 1725 of file Linker.php.
Referenced by Parser\finalizeHeadings(), generateTOC(), SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocLineEnd().
|
static |
Wraps the TOC in a div with ARIA navigation role and provides the hide/collapse JavaScript.
| string | $toc | Html of the Table Of Contents |
| Language | null | $lang | Language for the toc title, defaults to user language |
Definition at line 1737 of file Linker.php.
References $lang, $title, and wfMessage().
Referenced by Parser\finalizeHeadings(), generateTOC(), SpecialEditWatchlist\getNormalForm(), and DummyLinker\tocList().
|
static |
Finish one or more sublevels on the Table of Contents.
| int | $level |
Definition at line 1686 of file Linker.php.
Referenced by Parser\finalizeHeadings(), generateTOC(), and DummyLinker\tocUnindent().
|
static |
Returns raw bits of HTML, use titleAttrib()
| string | $name | |
| array | null | $options |
Definition at line 2354 of file Linker.php.
References titleAttrib().
Referenced by DummyLinker\tooltip().
|
static |
Returns the attributes for the tooltip and access key.
| string | $name | |
| array | $msgParams | Params for constructing the message |
| string | array | null | $options | Options to be passed to titleAttrib. |
Definition at line 2304 of file Linker.php.
References accesskey(), WatchedItem\getExpiry(), and titleAttrib().
Referenced by McrUndoAction\alterForm(), HTMLForm\getButtons(), VFormHTMLForm\getButtons(), HistoryPager\getStartBody(), HTMLFormField\getTooltipAndAccessKey(), Skin\makeLink(), Skin\makeSearchButton(), Skin\makeSearchInput(), UserrightsPage\showEditUserGroupsForm(), SpecialImport\showForm(), and DummyLinker\tooltipAndAccesskeyAttribs().
|
static |
Make user link (or user contributions for unregistered users)
| int | $userId | User id in database. |
| string | $userName | User name in database. |
| string | false | $altUserName | Text to display instead of the user name (optional) |
Definition at line 906 of file Linker.php.
References link(), NS_USER, TitleValue\tryNew(), wfDebug(), and wfMessage().
Referenced by SpecialFileDuplicateSearch\formatResult(), ActiveUsersPager\formatRow(), ContribsPager\formatRow(), UsersPager\formatRow(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), SpecialUndelete\getFileUser(), RCCacheEntryFactory\getUserLink(), RevDelFileItem\getUserTools(), ImageHistoryList\imageHistoryLine(), ChangesList\insertUserRelatedLinks(), LogFormatter\makeUserLink(), revUserLink(), revUserTools(), and DummyLinker\userLink().
|
static |
Definition at line 1045 of file Linker.php.
References link(), NS_USER_TALK, TitleValue\tryNew(), wfDebug(), and wfMessage().
Referenced by ContribsPager\formatRow(), DummyLinker\userTalkLink(), and userToolLinks().
|
static |
Generate standard user tool links (talk, contributions, block link, etc.)
| int | $userId | User identifier |
| string | $userText | User name or IP address |
| bool | $redContribsWhenNoEdits | Should the contributions link be red if the user has no edits? |
| int | $flags | Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK and Linker::TOOL_LINKS_EMAIL). |
| int | null | $edits | User edit count (optional, for performance) |
| bool | $useParentheses | (optional) Wrap comments in parentheses where needed |
Definition at line 951 of file Linker.php.
References $wgDisableAnonTalk, $wgLang, blockLink(), emailLink(), SpecialPage\getTitleFor(), link(), User\newFromId(), TOOL_LINKS_NOBLOCK, userTalkLink(), wfDebug(), and wfMessage().
Referenced by SpecialFileDuplicateSearch\formatResult(), ActiveUsersPager\formatRow(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), SpecialUndelete\getFileUser(), RevDelFileItem\getUserTools(), ImageHistoryList\imageHistoryLine(), ChangesList\insertUserRelatedLinks(), LogFormatter\makeUserLink(), RCCacheEntryFactory\newFromRecentChange(), revUserTools(), UserrightsPage\showEditUserGroupsForm(), DummyLinker\userToolLinks(), and userToolLinksRedContribs().
|
static |
Alias for userToolLinks( $userId, $userText, true );.
| int | $userId | User identifier |
| string | $userText | User name or IP address |
| int | null | $edits | User edit count (optional, for performance) |
| bool | $useParentheses | (optional) Wrap comments in parentheses where needed |
Definition at line 1033 of file Linker.php.
References userToolLinks().
Referenced by UsersPager\formatRow(), and DummyLinker\userToolLinksRedContribs().
|
static |
Definition at line 2155 of file Linker.php.
| const Linker::TOOL_LINKS_EMAIL = 2 |
Definition at line 41 of file Linker.php.
Referenced by UserrightsPage\showEditUserGroupsForm().
| const Linker::TOOL_LINKS_NOBLOCK = 1 |
Flags for userToolLinks()
Definition at line 40 of file Linker.php.
Referenced by BlockListPager\formatValue(), BlockLogFormatter\getMessageParameters(), and userToolLinks().
1.9.8