MediaWiki  REL1_22
Linker Class Reference

Some internal bits split of from Skin.php. More...

List of all members.

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)
 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)
 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)
 Formats wiki links and media links in text; all other wiki formatting is ignored.
static formatRevisionSize ($size)
static formatSize ($size)
 Format a size in bytes for output, using an appropriate unit (B, KB, MB or GB) according to the magnitude in question.
static formatTemplates ($templates, $preview=false, $section=false, $more=null)
 Returns HTML for the "templates used on this page" list.
static generateRollback ($rev, IContextSource $context=null, $options=array( 'verify'))
 Generate a rollback link for a given revision.
static generateTOC ($tree)
 Generate a table of contents from a section tree Currently unused.
static getExternalLinkAttributes ($class= 'external')
 Get the appropriate HTML attributes to add to the "a" element of an external link, as created by [wikisyntax].
static getInternalLinkAttributes ($title, $unused=null, $class= '')
 Get the appropriate HTML attributes to add to the "a" element of an internal link.
static getInternalLinkAttributesObj ($nt, $unused=null, $class= '', $title=false)
 Get the appropriate HTML attributes to add to the "a" element of an internal link, given the Title object for the page we want to link to.
static getInterwikiLinkAttributes ($title, $unused=null, $class= 'external')
 Get the appropriate HTML attributes to add to the "a" element of an interwiki link.
static getInvalidTitleDescription (IContextSource $context, $namespace, $title)
 Get a message saying that an invalid title was encountered.
static getLinkColour ($t, $threshold)
 Return the CSS colour of a known link.
static getRevDeleteLink (User $user, Revision $rev, Title $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=array(), $query=array(), $options=array())
 This function returns an HTML link to the given target.
static linkKnown ($target, $html=null, $customAttribs=array(), $query=array(), $options=array( 'known', 'noclasses'))
 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 makeBrokenLink ($title, $text= '', $query= '', $trail= '')
static makeBrokenLinkObj ($title, $text= '', $query= '', $trail= '', $prefix= '')
static makeColouredLinkObj ($nt, $colour, $text= '', $query= '', $trail= '', $prefix= '')
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=array(), $title=null)
 Make an external link.
static makeHeadline ($level, $attribs, $anchor, $html, $link, $legacyAnchor=false)
 Create a headline for content.
static makeImageLink ($parser, Title $title, $file, $frameParams=array(), $handlerParams=array(), $time=false, $query="", $widthOption=null)
 Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in the page.
static makeImageLink2 (Title $title, $file, $frameParams=array(), $handlerParams=array(), $time=false, $query="", $widthOption=null)
 See makeImageLink() When this function is removed, remove if( $parser instanceof Parser ) check there too.
static makeKnownLinkObj ($title, $text= '', $query= '', $trail= '', $prefix= '', $aprops= '', $style= '')
static makeLinkObj ($nt, $text= '', $query= '', $trail= '', $prefix= '')
static makeMediaLinkFile (Title $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 makeSizeLinkObj ($size, $nt, $text= '', $query= '', $trail= '', $prefix= '')
 Generate either a normal exists-style link or a stub link, depending on the given page size.
static makeThumbLink2 (Title $title, $file, $frameParams=array(), $handlerParams=array(), $time=false, $query="")
static makeThumbLinkObj (Title $title, $file, $label= '', $alt, $align= 'right', $params=array(), $framed=false, $manualthumb="")
 Make HTML for a thumbnail including image, border and caption.
static normaliseSpecialPage (Title $title)
static normalizeSubpageLink ($contextTitle, $target, &$text)
static revComment (Revision $rev, $local=false, $isPublic=false)
 Wrap and format the given revision's comment block, if the current user is allowed to view it.
static revDeleteLink ($query=array(), $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)
 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)
 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, $lang=false)
 Wraps the TOC in a table 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)
 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)
 Generate standard user tool links (talk, contributions, block link, etc.)
static userToolLinksRedContribs ($userId, $userText, $edits=null)
 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 $autocommentLocal
static $autocommentTitle
static $commentContextTitle
static $commentLocal

Static Protected Member Functions

static formatLinksInCommentCallback ($match)
static getUploadUrl ($destFile, $query= '')
 Get the URL to upload a certain file.
static processResponsiveImages ($file, $thumb, $hp)
 Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.

Static Private Member Functions

static fnamePart ($url)
 Returns the filename part of an url.
static formatAutocomments ($comment, $title=null, $local=false)
 Converts autogenerated comments in edit summaries into section links.
static formatAutocommentsCallback ($match)
 Helper function for Linker::formatAutocomments.
static getImageLinkMTOParams ($frameParams, $query= '', $parser=null)
 Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by the Parser.
static getLinkAttributesInternal ($title, $class)
 Common code for getLinkAttributesX functions.
static linkAttribs ($target, $attribs, $options)
 Returns the array of attributes used when linking to the Title $target.
static linkText ($target)
 Default text of the links to the Title $target.
static linkUrl ($target, $query, $options)
 Returns the Url used to link to a Title.

Detailed Description

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 30 of file Linker.php.


Member Function Documentation

static Linker::accesskey ( name) [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.)

Parameters:
string$nameid of the element, minus prefixes.
Returns:
String: contents of the accesskey attribute (which you must HTML- escape), or false for no accesskey attribute

Definition at line 2142 of file Linker.php.

static Linker::blockLink ( userId,
userText 
) [static]
Parameters:
$userIdInteger: userid
string$userTextuser name in database.
Returns:
String: HTML fragment with block link

Definition at line 1201 of file Linker.php.

References SpecialPage\getTitleFor(), link(), and wfMessage().

Referenced by userToolLinks().

static Linker::buildRollbackLink ( rev,
IContextSource context = null,
editCount = false 
) [static]

Build a raw rollback link, useful for collections of "tool" links.

Parameters:
$revRevision object
$contextIContextSource context to use or null for the main context.
$editCountinteger Number of edits that would be reverted
Returns:
String: HTML fragment

Definition at line 1887 of file Linker.php.

References $query, $rev, array(), as, RequestContext\getMain(), Title\getPrefixedText(), getRollbackEditCount(), global, and link().

Referenced by generateRollback().

static Linker::commentBlock ( comment,
title = null,
local = false 
) [static]

Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty string.

Parameters:
$commentString
$titleMixed: Title object (to generate link to section in autocomment) or null
$localBoolean: whether section links should refer to local page
Returns:
string

Definition at line 1582 of file Linker.php.

References $comment, formatComment(), and wfMessage().

Referenced by RevDel_LogItem\getHTML(), and revComment().

static Linker::emailLink ( userId,
userText 
) [static]
Parameters:
$userIdInteger: userid
string$userTextuser name in database.
Returns:
String: HTML fragment with e-mail user link

Definition at line 1212 of file Linker.php.

References SpecialPage\getTitleFor(), link(), and wfMessage().

Referenced by userToolLinks().

static Linker::fnamePart ( url) [static, private]

Returns the filename part of an url.

Used as alternative text for external images.

Parameters:
$urlstring
Returns:
string

Definition at line 493 of file Linker.php.

Referenced by makeExternalImage().

static Linker::formatAutocomments ( comment,
title = null,
local = false 
) [static, private]

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.

Parameters:
string$commentcomment text
$titleTitle|null An optional title object used to links to sections
$localBoolean: whether section links should refer to local page
Returns:
String: formatted comment

Definition at line 1315 of file Linker.php.

References $comment, $title, and array().

Referenced by formatComment().

static Linker::formatComment ( comment,
title = null,
local = false 
) [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]].

Author:
Erik Moeller <[email protected]>

Note: there's not always a title to pass to this function. Since you can't set a default parameter for a reference, I've turned it temporarily to a value pass. Should be adjusted further. --brion

Parameters:
$commentString
$titleMixed: Title object (to generate link to the section in autocomment) or null
$localBoolean: whether section links should refer to local page
Returns:
mixed|String

Definition at line 1280 of file Linker.php.

References $comment, Sanitizer\escapeHtmlAllowEntities(), formatAutocomments(), formatLinksInComment(), wfProfileIn(), and wfProfileOut().

Referenced by commentBlock(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryWatchlist\extractRowInfo(), ApiQueryContributions\extractRowInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryRevisions\extractRowInfo(), FeedUtils\formatDiffRow(), BlockListPager\formatValue(), ImageListPager\formatValue(), ApiQueryImageInfo\getInfo(), ImageHistoryList\imageHistoryLine(), RollbackAction\onView(), ApiQueryProtectedTitles\run(), and NewParserTest\testParserTest().

static Linker::formatHiddenCategories ( hiddencats) [static]

Returns HTML for the "hidden categories on this page" list.

Parameters:
array$hiddencatsof hidden categories from Article::getHiddenCategories or similar
Returns:
String: HTML output

Definition at line 2055 of file Linker.php.

References array(), as, it, link(), wfMessage(), and wfProfileIn().

Referenced by InfoAction\pageInfo().

static Linker::formatLinksInComment ( comment,
title = null,
local = false 
) [static]

Formats wiki links and media links in text; all other wiki formatting is ignored.

Todo:
FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
Parameters:
string$commenttext to format links in
$titleTitle|null An optional title object used to links to sections
$localBoolean: whether section links should refer to local page
Returns:
String

Definition at line 1399 of file Linker.php.

References $comment, $html, $title, and array().

Referenced by formatComment().

static Linker::formatRevisionSize ( size) [static]
Parameters:
$size
Returns:
string

Definition at line 1626 of file Linker.php.

References $size, and wfMessage().

Referenced by SpecialMergeHistory\formatRevisionRow(), and SpecialProtectedpages\formatRow().

static Linker::formatSize ( size) [static]

Format a size in bytes for output, using an appropriate unit (B, KB, MB or GB) according to the magnitude in question.

Parameters:
int$sizeSize to format
Returns:
String

Definition at line 2081 of file Linker.php.

Referenced by ImageHistoryList\imageHistoryLine().

static Linker::formatTemplates ( templates,
preview = false,
section = false,
more = null 
) [static]

Returns HTML for the "templates used on this page" list.

Make an HTML list of templates, and then add a "More..." link at the bottom. If $more is null, do not add a "More..." link. If $more is a Title, make a link to that title and use it. If $more is a string, directly paste it in as the link (escaping needs to be done manually). Finally, if $more is a Message, call toString().

Parameters:
array$templatesArray of templates from Article::getUsedTemplate or similar
bool$previewWhether this is for a preview
bool$sectionWhether this is for a section edit
Title | Message | string | null$moreAn escaped link for "More..." of the templates
Returns:
String: HTML output

Definition at line 1962 of file Linker.php.

References $batch, $section, $wgLang, array(), as, global, link(), text, wfMessage(), wfProfileIn(), and wfProfileOut().

Referenced by InfoAction\pageInfo().

static Linker::generateRollback ( rev,
IContextSource context = null,
options = array( 'verify' ) 
) [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 []

Parameters:
$revRevision object
$contextIContextSource context to use or null for the main context.
$optionsarray
Returns:
string

Definition at line 1796 of file Linker.php.

References $options, $rev, buildRollbackLink(), RequestContext\getMain(), and getRollbackEditCount().

static Linker::generateTOC ( tree) [static]

Generate a table of contents from a section tree Currently unused.

Parameters:
array$treeReturn value of ParserOutput::getSections()
Returns:
String: HTML fragment

Definition at line 1704 of file Linker.php.

References $section, as, tocIndent(), tocLine(), tocLineEnd(), tocList(), and tocUnindent().

static Linker::getExternalLinkAttributes ( class = 'external') [static]

Get the appropriate HTML attributes to add to the "a" element of an external link, as created by [wikisyntax].

Parameters:
string$classthe contents of the class attribute; if an empty string is passed, which is the default value, defaults to 'external'.
Returns:
string
Deprecated:
since 1.18 Just pass the external class directly to something using Html::expandAttributes

Definition at line 47 of file Linker.php.

References getLinkAttributesInternal(), and wfDeprecated().

static Linker::getImageLinkMTOParams ( frameParams,
query = '',
parser = null 
) [static, private]

Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by the Parser.

Parameters:
array$frameParamsThe frame parameters
string$queryAn optional query string to add to description page links
Returns:
array

Definition at line 715 of file Linker.php.

References $name, $parser, $query, array(), as, empty, and normaliseSpecialPage().

Referenced by makeImageLink(), and makeThumbLink2().

static Linker::getInternalLinkAttributes ( title,
unused = null,
class = '' 
) [static]

Get the appropriate HTML attributes to add to the "a" element of an internal link.

Parameters:
string$titlethe title text for the link, URL-encoded (???) but not HTML-escaped
string$unusedunused
string$classthe contents of the class attribute, default none
Returns:
string

Definition at line 83 of file Linker.php.

References $title, and getLinkAttributesInternal().

static Linker::getInternalLinkAttributesObj ( nt,
unused = null,
class = '',
title = false 
) [static]

Get the appropriate HTML attributes to add to the "a" element of an internal link, given the Title object for the page we want to link to.

Parameters:
$ntTitle
string$unusedunused
string$classthe contents of the class attribute, default none
$titleMixed: optional (unescaped) string to use in the title attribute; if false, default to the name of the page we're linking to
Returns:
string

Definition at line 100 of file Linker.php.

References $title, and getLinkAttributesInternal().

Referenced by makeColouredLinkObj().

static Linker::getInterwikiLinkAttributes ( title,
unused = null,
class = 'external' 
) [static]

Get the appropriate HTML attributes to add to the "a" element of an interwiki link.

Parameters:
string$titlethe title text for the link, URL-encoded (???) but not HTML-escaped
string$unusedunused
string$classthe contents of the class attribute; if an empty string is passed, which is the default value, defaults to 'external'.
Returns:
string

Definition at line 62 of file Linker.php.

References $title, $wgContLang, getLinkAttributesInternal(), and global.

static Linker::getInvalidTitleDescription ( IContextSource context,
namespace,
title 
) [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.

Parameters:
$contextIContextSource context to use to get the messages
int$namespaceNamespace number
string$titleText of the title, without the namespace part
Returns:
string

Definition at line 451 of file Linker.php.

References $name, $title, $wgContLang, MWNamespace\exists(), global, and IContextSource\msg().

Referenced by PageQueryPage\formatResult(), PopularPagesPage\formatResult(), UnwatchedpagesPage\formatResult(), FewestrevisionsPage\formatResult(), MostlinkedCategoriesPage\formatResult(), ShortPagesPage\formatResult(), MostcategoriesPage\formatResult(), MostinterwikisPage\formatResult(), MostlinkedTemplatesPage\formatResult(), MostlinkedPage\formatResult(), SpecialProtectedtitles\formatRow(), and SpecialProtectedpages\formatRow().

static Linker::getLinkAttributesInternal ( title,
class 
) [static, private]

Common code for getLinkAttributesX functions.

Parameters:
$titlestring
$classstring
Returns:
string

Definition at line 115 of file Linker.php.

References $title.

Referenced by getExternalLinkAttributes(), getInternalLinkAttributes(), getInternalLinkAttributesObj(), and getInterwikiLinkAttributes().

static Linker::getLinkColour ( t,
threshold 
) [static]

Return the CSS colour of a known link.

Parameters:
$tTitle object
$thresholdInteger: user defined threshold
Returns:
String: CSS class

Definition at line 135 of file Linker.php.

References $t.

Referenced by LinkHolderArray\doVariants(), linkAttribs(), and LinkHolderArray\replaceInternal().

static Linker::getRevDeleteLink ( User user,
Revision rev,
Title title 
) [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.

Parameters:
User$user
Revision$rev
Revision$title
Returns:
string HTML fragment

Definition at line 2179 of file Linker.php.

static Linker::getRollbackEditCount ( rev,
verify 
) [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.

Parameters:
$revRevision object
bool$verifyTry to verify that this revision can really be rolled back
Returns:
integer|bool|null

Definition at line 1832 of file Linker.php.

References $dbr, $res, $rev, array(), as, Revision\DELETED_TEXT, Revision\DELETED_USER, global, and wfGetDB().

Referenced by buildRollbackLink(), and generateRollback().

static Linker::getUploadUrl ( destFile,
query = '' 
) [static, protected]

Get the URL to upload a certain file.

Parameters:
$destFileTitle object of the file to upload
string$queryurlencoded query string to prepend
Returns:
String: urlencoded URL

Definition at line 978 of file Linker.php.

References $query, $upload, SpecialPage\getTitleFor(), global, and wfAppendQuery().

Referenced by makeBrokenImageLinkObj(), and makeMediaLinkFile().

static Linker::link ( target,
html = null,
customAttribs = array(),
query = array(),
options = array() 
) [static]

This function returns an HTML link to the given target.

It serves a few purposes: 1) If $target is a Title, 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 Title (the page name of the target). link() replaces the old functions in the makeLink() family.

Since:
1.18 Method exists since 1.16 as non-static, made static in 1.18. You can call it using this if you want to keep compat with these: $linker = class_exists( 'DummyLinker' ) ? new DummyLinker() : new Linker(); $linker->link( ... );
Parameters:
$targetTitle Can currently only be a Title, but this may change to support Images, literal URLs, etc.
$htmlstring 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 Title; or if the Title is just a fragment, the contents of the fragment.
array$customAttribsA 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.
$queryarray 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$optionsString 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.
Returns:
string HTML attribute

Definition at line 193 of file Linker.php.

References $attribs, $customAttribs, $html, $options, $query, $ret, array(), linkText(), normaliseSpecialPage(), Html\rawElement(), wfAppendQuery(), wfCgiToArray(), wfDeprecated(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by DeletedContributionsPage\__construct(), CategoryViewer\addSubcategoryObject(), blockLink(), ProtectionForm\buildForm(), SpecialEditWatchlist\buildRemoveLine(), buildRollbackLink(), SpecialContributions\contributionsSub(), Skin\doEditSectionLink(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), Skin\drawCategoryBrowser(), emailLink(), UserloginTemplate\execute(), SpecialListGroupRights\execute(), SpecialNewpages\filterLinks(), formatAutocommentsCallback(), formatHiddenCategories(), formatLinksInCommentCallback(), WantedCategoriesPage\formatResult(), UnusedCategoriesPage\formatResult(), MostlinkedCategoriesPage\formatResult(), ShortPagesPage\formatResult(), MostcategoriesPage\formatResult(), MostinterwikisPage\formatResult(), BrokenRedirectsPage\formatResult(), MostlinkedTemplatesPage\formatResult(), ListredirectsPage\formatResult(), MostlinkedPage\formatResult(), DoubleRedirectsPage\formatResult(), SpecialPagesWithProp\formatResult(), MIMEsearchPage\formatResult(), SpecialProtectedtitles\formatRow(), SpecialProtectedpages\formatRow(), CategoryPager\formatRow(), NewFilesPager\formatRow(), formatTemplates(), ImageListPager\formatValue(), Preferences\generateSkinOptions(), PreferencesForm\getButtons(), Skin\getCategoryLinks(), InfoAction\getContributors(), RevDel_ArchiveItem\getDiffLink(), SpecialUnblock\getFields(), SpecialEmailUser\getFormFields(), SpecialJavaScriptTest\getFrameworkListHtml(), SpecialStatistics\getGroupStats(), RevDel_LogItem\getHTML(), RevDel_ArchivedFileItem\getLink(), PatrolLogFormatter\getMessageParameters(), SpecialStatistics\getMostViewedPages(), RevDel_ArchiveItem\getRevisionLink(), linkKnown(), makeBrokenLinkObj(), makeImageLink(), makeKnownLinkObj(), makeLinkObj(), MostlinkedTemplatesPage\makeWlhLink(), InfoAction\pageInfo(), SpecialBlock\postText(), Preferences\profilePreferences(), EnhancedChangesList\recentChangesBlockGroup(), EnhancedChangesList\recentChangesLine(), LinkHolderArray\replaceInternal(), LinkHolderArray\replaceInterwiki(), revDeleteLink(), SpecialRevisionDelete\showForm(), MovePageForm\showSubpages(), SpecialEditWatchlist\showTitles(), Preferences\skinPreferences(), TraditionalImageGallery\toHTML(), userLink(), userTalkLink(), and userToolLinks().

static Linker::linkAttribs ( target,
attribs,
options 
) [static, private]

Returns the array of attributes used when linking to the Title $target.

Parameters:
$targetTitle
$attribs
$options
Returns:
array

Definition at line 320 of file Linker.php.

References $attribs, $key, $options, $ret, $wgUser, array(), as, getLinkColour(), global, Sanitizer\mergeAttributes(), redirect, see, text, wfMessage(), wfProfileIn(), and wfProfileOut().

static Linker::linkKnown ( target,
html = null,
customAttribs = array(),
query = array(),
options = array( 'known', 'noclasses' ) 
) [static]

Identical to link(), except $options defaults to 'known'.

Returns:
string

Definition at line 265 of file Linker.php.

References $customAttribs, $html, $options, $query, and link().

Referenced by DeletedContributionsPage\__construct(), SpecialEditWatchlist\buildRemoveLine(), SpecialEditWatchlist\buildTools(), SpecialWatchlist\daysLink(), MovePageForm\doSubmit(), SpecialWatchlist\execute(), SpecialListGroupRights\execute(), SpecialJavaScriptTest\execute(), EmailConfirmation\execute(), SpecialEditWatchlist\execute(), Skin\footerLink(), PageQueryPage\formatResult(), UncategorizedCategoriesPage\formatResult(), PopularPagesPage\formatResult(), UnusedtemplatesPage\formatResult(), AncientPagesPage\formatResult(), UnwatchedpagesPage\formatResult(), FewestrevisionsPage\formatResult(), ShortPagesPage\formatResult(), MostcategoriesPage\formatResult(), MostinterwikisPage\formatResult(), BrokenRedirectsPage\formatResult(), DoubleRedirectsPage\formatResult(), LinkSearchPage\formatResult(), SpecialMergeHistory\formatRevisionRow(), SpecialProtectedpages\formatRow(), BlockListPager\formatValue(), ImageListPager\formatValue(), MoveLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), Skin\getCopyright(), HistoryAction\getDescription(), RevDel_RevisionItem\getDiffLink(), SpecialStatistics\getGroupStats(), Skin\getNewtalks(), SpecialStatistics\getPageStats(), RevDel_RevisionItem\getRevisionLink(), Skin\getUndeleteLink(), SpecialStatistics\getUserStats(), SpecialWatchlist\hoursLink(), ImageHistoryList\imageHistoryLine(), Skin\mainPageLink(), makeBrokenImageLinkObj(), SpecialRecentChanges\makeOptionsLink(), MostlinkedPage\makeWlhLink(), CreditsAction\othersLink(), SpecialSpecialpages\outputPageList(), InfoAction\pageInfo(), SpecialBlock\postText(), Preferences\profilePreferences(), EnhancedChangesList\recentChangesBlockGroup(), EnhancedChangesList\recentChangesBlockLine(), EnhancedChangesList\recentChangesLine(), ImportReporter\reportPage(), SpecialRevisionDelete\showConvenienceLinks(), SpecialWatchlist\showHideLink(), SpecialPrefixindex\showPrefixChunk(), SpecialSearch\showResults(), specialLink(), Skin\subPageSubtitle(), and CologneBlueTemplate\sysLinks().

static Linker::linkText ( target) [static, private]

Default text of the links to the Title $target.

Parameters:
$targetTitle
Returns:
string

Definition at line 382 of file Linker.php.

Referenced by link(), makeBrokenLinkObj(), makeKnownLinkObj(), and makeLinkObj().

static Linker::linkUrl ( target,
query,
options 
) [static, private]

Returns the Url used to link to a Title.

Parameters:
$targetTitle
array$queryquery parameters
$optionsArray
Returns:
String

Definition at line 280 of file Linker.php.

References $options, $query, $ret, empty, wfProfileIn(), and wfProfileOut().

static Linker::makeBrokenImageLinkObj ( title,
label = '',
query = '',
unused1 = '',
unused2 = '',
time = false 
) [static]

Make a "broken" link to an image.

Parameters:
$titleTitle object
string$labellink label (plain text)
string$queryquery string
$unused1Unused parameter kept for b/c
$unused2Unused parameter kept for b/c
$timeBoolean: a file of a certain timestamp was requested
Returns:
String

Definition at line 939 of file Linker.php.

References $query, $time, array(), false, Title\getPrefixedText(), getUploadUrl(), global, linkKnown(), RepoGroup\singleton(), wfCgiToArray(), wfFindFile(), wfProfileIn(), and wfProfileOut().

Referenced by makeImageLink(), and makeThumbLink2().

static Linker::makeBrokenLink ( title,
text = '',
query = '',
trail = '' 
) [static]
Deprecated:
since 1.16 Use link()

This function is a shortcut to makeBrokenLinkObj(Title::newFromText($title),...). Do not call it if you already have a title object handy. See makeBrokenLinkObj for further documentation.

Parameters:
string$titleThe text of the title
string$textLink text
string$queryOptional query part
string$trailOptional trail. Alphabetic characters at the start of this string will be included in the link text. Other characters will be appended after the end of the link.
Returns:
string

Definition at line 2260 of file Linker.php.

References $query, makeBrokenLinkObj(), Title\newFromText(), wfDebug(), and wfDeprecated().

static Linker::makeBrokenLinkObj ( title,
text = '',
query = '',
trail = '',
prefix = '' 
) [static]
Deprecated:
since 1.16 Use link()

Make a red link to the edit page of a given title.

Parameters:
$titleTitle object of the target page
$textString: Link text
string$queryOptional query part
string$trailOptional trail. Alphabetic characters at the start of this string will be included in the link text. Other characters will be appended after the end of the link.
string$prefixOptional prefix
Returns:
string

Definition at line 2359 of file Linker.php.

References $query, $ret, array(), link(), linkText(), list, splitTrail(), wfCgiToArray(), wfDeprecated(), wfProfileIn(), and wfProfileOut().

Referenced by makeBrokenLink().

static Linker::makeColouredLinkObj ( nt,
colour,
text = '',
query = '',
trail = '',
prefix = '' 
) [static]
Deprecated:
since 1.16 Use link()

Make a coloured link.

Parameters:
$ntTitle object of the target page
$colourInteger: colour of the link
$textString: link text
$queryString: optional query part
$trailString: optional trail. Alphabetic characters at the start of this string will be included in the link text. Other characters will be appended after the end of the link.
string$prefixOptional prefix
Returns:
string

Definition at line 2391 of file Linker.php.

References $query, getInternalLinkAttributesObj(), makeKnownLinkObj(), and wfDeprecated().

Referenced by makeSizeLinkObj().

static Linker::makeExternalImage ( url,
alt = '' 
) [static]

Return the code for images which were added via external links, via Parser::maybeMakeExternalImage().

Parameters:
$url
$alt
Returns:
string

Definition at line 512 of file Linker.php.

References $success, array(), Html\element(), fnamePart(), wfDebug(), and wfRunHooks().

Referenced by Parser\maybeMakeExternalImage().

static Linker::makeExternalLink ( url,
text,
escape = true,
linktype = '',
attribs = array(),
title = null 
) [static]

Make an external link.

Parameters:
string$urlURL to link to
string$texttext of link
$escapeBoolean: do we escape the link text?
string$linktypetype of external link. Gets added to the classes
array$attribsof extra attributes to
$titleTitle|null Title object used for title specific link attributes
Returns:
string

Definition at line 1060 of file Linker.php.

References $attribs, $link, $success, $wgTitle, array(), Parser\getExternalLinkRel(), global, Html\rawElement(), wfDebug(), and wfRunHooks().

Referenced by LinkSearchPage\formatResult(), Skin\getCopyright(), WikiMap\makeForeignLink(), and CologneBlueTemplate\sysLinks().

static Linker::makeHeadline ( level,
attribs,
anchor,
html,
link,
legacyAnchor = false 
) [static]

Create a headline for content.

Parameters:
$levelInteger: the level of the headline (1-6)
string$attribsany attributes for the headline, starting with a space and ending with '>' This *must* be at least '>' for no attribs
string$anchorthe anchor to give the headline (the bit after the #)
string$htmlhtml for the text of the header
string$linkHTML to add for the section edit link
$legacyAnchorMixed: a second, optional anchor to give for backward compatibility (false to omit)
Returns:
String: HTML headline

Definition at line 1741 of file Linker.php.

References $link, and $ret.

static Linker::makeImageLink ( parser,
Title title,
file,
frameParams = array(),
handlerParams = array(),
time = false,
query = "",
widthOption = null 
) [static]

Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in the page.

Parameters:
$parserParser object
$titleTitle object of the file (not the currently viewed page)
$fileFile object, or false if it doesn't exist
array$frameParamsassociative 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 Title object to link to link-target Value for the target attribute, only with link-url no-link Boolean, suppress description link
array$handlerParamsassociative array of media handler parameters, to be passed to transform(). Typical keys are "width" and "page".
string$timetimestamp of the file, set as false for current
string$queryquery params for desc url
$widthOption,:Used by the parser to remember the user preference thumbnailsize
Since:
1.20
Returns:
String: HTML for an image, with links, wrappers, etc.

Definition at line 564 of file Linker.php.

References $file, $handlerParams, $params, $parser, $query, $res, $s, $time, $wgContLang, array(), User\getDefaultOption(), getImageLinkMTOParams(), Title\getPrefixedDBkey(), global, link(), makeBrokenImageLinkObj(), makeThumbLink2(), processResponsiveImages(), wfDebug(), and wfRunHooks().

Referenced by makeImageLink2().

static Linker::makeImageLink2 ( Title title,
file,
frameParams = array(),
handlerParams = array(),
time = false,
query = "",
widthOption = null 
) [static]

See makeImageLink() When this function is removed, remove if( $parser instanceof Parser ) check there too.

Deprecated:
since 1.20

Definition at line 702 of file Linker.php.

References $file, $handlerParams, $query, $time, and makeImageLink().

static Linker::makeKnownLinkObj ( title,
text = '',
query = '',
trail = '',
prefix = '',
aprops = '',
style = '' 
) [static]
Deprecated:
since 1.16 Use link(); warnings since 1.21

Make a link for a title which definitely exists. This is faster than makeLinkObj because it doesn't have to do a database query. It's also valid for interwiki titles and special pages.

Parameters:
$titleTitle object of target page
$textString: text to replace the title
$queryString: link target
$trailString: text after link
string$prefixtext before link text
string$apropsextra attributes to the a-element
$styleString: style to apply - if empty, use getInternalLinkAttributesObj instead
Returns:
string the a-element

Definition at line 2321 of file Linker.php.

References $attribs, $query, $ret, array(), Sanitizer\decodeTagAttributes(), link(), linkText(), list, Sanitizer\mergeAttributes(), splitTrail(), wfCgiToArray(), wfDeprecated(), wfProfileIn(), and wfProfileOut().

Referenced by makeColouredLinkObj().

static Linker::makeLinkObj ( nt,
text = '',
query = '',
trail = '',
prefix = '' 
) [static]
Deprecated:
since 1.16 Use link(); warnings since 1.21

Make a link for a title which may or may not be in the database. If you need to call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each call to this will result in a DB query.

Parameters:
$ntTitle: the title object to make the link from, e.g. from Title::newFromText.
$textString: link text
string$queryoptional query part
string$trailoptional trail. Alphabetic characters at the start of this string will be included in the link text. Other characters will be appended after the end of the link.
string$prefixoptional prefix. As trail, only before instead of after.
Returns:
string

Definition at line 2289 of file Linker.php.

References $query, $ret, array(), link(), linkText(), list, splitTrail(), wfCgiToArray(), wfDeprecated(), wfProfileIn(), and wfProfileOut().

static Linker::makeMediaLinkFile ( Title title,
file,
html = '' 
) [static]

Create a direct link to a given uploaded file.

This will make a broken link if $file is false.

Parameters:
$titleTitle object.
$fileFile|bool mixed File object or false
string$htmlpre-sanitized HTML
Returns:
String: HTML
Todo:
Handle invalid or missing images better.

Definition at line 1019 of file Linker.php.

References $file, $html, Title\getText(), and getUploadUrl().

Referenced by makeMediaLinkObj().

static Linker::makeMediaLinkObj ( title,
html = '',
time = false 
) [static]

Create a direct link to a given uploaded file.

Parameters:
$titleTitle object.
string$htmlpre-sanitized HTML
string$timeMW timestamp of file creation time
Returns:
String: HTML

Definition at line 1003 of file Linker.php.

References $html, $time, array(), makeMediaLinkFile(), and wfFindFile().

Referenced by formatLinksInCommentCallback(), and MIMEsearchPage\formatResult().

static Linker::makeSelfLinkObj ( nt,
html = '',
query = '',
trail = '',
prefix = '' 
) [static]

Make appropriate markup for a link to the current article.

This is currently rendered as the bold link text. The calling sequence is the same as the other make*LinkObj static functions, despite $query not being used.

Parameters:
$ntTitle
string$html[optional]
string$query[optional]
string$trail[optional]
string$prefix[optional]
Returns:
string

Definition at line 433 of file Linker.php.

References $html, list, and splitTrail().

Referenced by LinkHolderArray\replaceInternal().

static Linker::makeSizeLinkObj ( size,
nt,
text = '',
query = '',
trail = '',
prefix = '' 
) [static]

Generate either a normal exists-style link or a stub link, depending on the given page size.

Parameters:
$sizeInteger
$ntTitle object.
$textString
$queryString
$trailString
$prefixString
Returns:
string HTML of link
Deprecated:
since 1.17

Definition at line 409 of file Linker.php.

References $query, $size, $wgUser, global, makeColouredLinkObj(), and wfDeprecated().

static Linker::makeThumbLink2 ( Title title,
file,
frameParams = array(),
handlerParams = array(),
time = false,
query = "" 
) [static]
Parameters:
$titleTitle
$fileFile
array$frameParams
array$handlerParams
bool$time
string$query
Returns:
mixed

Definition at line 778 of file Linker.php.

References $file, $handlerParams, $params, $query, $s, $time, $wgContLang, array(), Html\element(), empty, getImageLinkMTOParams(), Title\getLocalURL(), global, makeBrokenImageLinkObj(), Title\makeTitleSafe(), processResponsiveImages(), Html\rawElement(), text, wfAppendQuery(), wfFindFile(), and wfMessage().

Referenced by makeImageLink(), and makeThumbLinkObj().

static Linker::makeThumbLinkObj ( Title title,
file,
label = '',
alt,
align = 'right',
params = array(),
framed = false,
manualthumb = "" 
) [static]

Make HTML for a thumbnail including image, border and caption.

Parameters:
$titleTitle object
$fileFile object or false if it doesn't exist
$labelString
$altString
$alignString
$paramsArray
$framedBoolean
$manualthumbString
Returns:
mixed

Definition at line 752 of file Linker.php.

References $file, $params, array(), and makeThumbLink2().

static Linker::normalizeSubpageLink ( contextTitle,
target,
&$  text 
) [static]
Parameters:
$contextTitleTitle
$target
$text
Returns:
string

Definition at line 1500 of file Linker.php.

References $hash, $ret, array(), below, change, changed, MWNamespace\hasSubpages(), is, page, reasons, wfProfileIn(), and wfProfileOut().

Referenced by Parser\closeParagraph(), and formatLinksInCommentCallback().

static Linker::processResponsiveImages ( file,
thumb,
hp 
) [static, protected]

Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.

Parameters:
File$file
MediaOutput$thumb
array$hpimage parameters

Definition at line 905 of file Linker.php.

References $file, and global.

Referenced by makeImageLink(), and makeThumbLink2().

static Linker::revComment ( Revision rev,
local = false,
isPublic = false 
) [static]

Wrap and format the given revision's comment block, if the current user is allowed to view it.

Parameters:
$revRevision object
$localBoolean: whether section links should refer to local page
$isPublicBoolean: show only if all users can see it
Returns:
String: HTML fragment

Definition at line 1604 of file Linker.php.

References commentBlock(), Revision\DELETED_COMMENT, Revision\FOR_THIS_USER, Revision\getComment(), Revision\getRawComment(), Revision\getTitle(), Revision\isDeleted(), Revision\userCan(), and wfMessage().

Referenced by SpecialMergeHistory\formatRevisionRow(), RevDel_RevisionItem\getHTML(), and RevisionItem\getHTML().

static Linker::revDeleteLink ( query = array(),
restricted = false,
delete = true 
) [static]

Creates a (show/hide) link for deleting revisions/log entries.

Parameters:
array$queryquery parameters to be passed to link()
$restrictedBoolean: set to true to use a "<strong>" instead of a "<span>"
$deleteBoolean: set to true to use (show/hide) rather than (show)
Returns:
String: HTML "<a>" link to Special:Revisiondelete, wrapped in a span to allow for customization of appearance with CSS

Definition at line 2220 of file Linker.php.

References $html, $link, $query, array(), SpecialPage\getTitleFor(), link(), tags(), and wfMessage().

Referenced by ImageHistoryList\imageHistoryLine().

static Linker::revDeleteLinkDisabled ( delete = true) [static]

Creates a dead (show/hide) link for deleting revisions/log entries.

Parameters:
$deleteBoolean: set to true to use (show/hide) rather than (show)
Returns:
string HTML text wrapped in a span to allow for customization of appearance with CSS

Definition at line 2237 of file Linker.php.

References $html, array(), tags(), and wfMessage().

Referenced by ImageHistoryList\imageHistoryLine().

static Linker::revUserLink ( rev,
isPublic = false 
) [static]

Generate a user link if the current user is allowed to view it.

Parameters:
$revRevision object.
$isPublicBoolean: show only if all users can see it
Returns:
String: HTML fragment

Definition at line 1224 of file Linker.php.

References $link, $rev, Revision\DELETED_USER, Revision\FOR_THIS_USER, userLink(), and wfMessage().

Referenced by RevDel_RevisionItem\getHTML(), and RevisionItem\getHTML().

static Linker::revUserTools ( rev,
isPublic = false 
) [static]

Generate a user tool link cluster if the current user is allowed to view it.

Parameters:
$revRevision object.
$isPublicBoolean: show only if all users can see it
Returns:
string HTML

Definition at line 1245 of file Linker.php.

References $link, $rev, Revision\DELETED_USER, Revision\FOR_THIS_USER, userLink(), userToolLinks(), and wfMessage().

Referenced by SpecialMergeHistory\formatRevisionRow(), RollbackAction\onView(), and InfoAction\pageInfo().

static Linker::specialLink ( name,
key = '' 
) [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' )

Returns:
string

Definition at line 1042 of file Linker.php.

References $key, $name, SpecialPage\getTitleFor(), linkKnown(), text, and wfMessage().

static Linker::splitTrail ( trail) [static]

Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array.

Returns:
array

Definition at line 1757 of file Linker.php.

References $wgContLang, array(), and global.

Referenced by formatLinksInCommentCallback(), makeBrokenLinkObj(), LinkHolderArray\makeHolder(), makeKnownLinkObj(), makeLinkObj(), and makeSelfLinkObj().

static Linker::titleAttrib ( name,
options = null 
) [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.)

Parameters:
string$nameid of the element, minus prefixes.
$optionsMixed: null or the string 'withaccess' to add an access- key hint
Returns:
String: contents of the title attribute (which you must HTML- escape), or false for no title attribute

Definition at line 2098 of file Linker.php.

Referenced by MonoBookTemplate\customBox(), BaseTemplate\makeLink(), and tooltip().

static Linker::tocIndent ( ) [static]

Add another level to the Table of Contents.

Returns:
string

Definition at line 1641 of file Linker.php.

Referenced by generateTOC(), and SpecialEditWatchlist\getNormalForm().

static Linker::tocLine ( anchor,
tocline,
tocnumber,
level,
sectionIndex = false 
) [static]

parameter level defines if we are on an indentation level

Returns:
string

Definition at line 1659 of file Linker.php.

Referenced by generateTOC(), and SpecialEditWatchlist\getNormalForm().

static Linker::tocLineEnd ( ) [static]

End a Table Of Contents line.

tocUnindent() will be used instead if we're ending a line below the new level.

Returns:
string

Definition at line 1676 of file Linker.php.

Referenced by generateTOC(), and SpecialEditWatchlist\getNormalForm().

static Linker::tocList ( toc,
lang = false 
) [static]

Wraps the TOC in a table and provides the hide/collapse javascript.

Parameters:
string$tochtml of the Table Of Contents
$langString|Language|false: Language for the toc title, defaults to user language
Returns:
String: full html of the TOC

Definition at line 1687 of file Linker.php.

References wfGetLangObj(), and wfMessage().

Referenced by generateTOC(), and SpecialEditWatchlist\getNormalForm().

static Linker::tocUnindent ( level) [static]

Finish one or more sublevels on the Table of Contents.

Returns:
string

Definition at line 1650 of file Linker.php.

Referenced by generateTOC().

static Linker::tooltip ( name,
options = null 
) [static]

Returns raw bits of HTML, use titleAttrib()

Returns:
null|string

Definition at line 2427 of file Linker.php.

References $name, $options, array(), Xml\expandAttributes(), and titleAttrib().

Referenced by VectorTemplate\execute(), and VectorTemplate\renderPortal().

static Linker::userLink ( userId,
userName,
altUserName = false 
) [static]

Make user link (or user contributions for unregistered users)

Parameters:
$userIdInteger: user id in database.
string$userNameuser name in database.
string$altUserNametext to display instead of the user name (optional)
Returns:
String: HTML fragment
Since:
1.19 Method exists for a long time. $altUserName was added in 1.19.

Definition at line 1098 of file Linker.php.

References array(), SpecialPage\getTitleFor(), link(), Title\makeTitle(), and IP\prettifyIP().

Referenced by UsersPager\formatRow(), BlockListPager\formatValue(), ImageHistoryList\imageHistoryLine(), LogFormatter\makeUserLink(), EnhancedChangesList\recentChangesLine(), revUserLink(), revUserTools(), and LinkerTest\testUserLink().

static Linker::userTalkLink ( userId,
userText 
) [static]
Parameters:
$userIdInteger: user id in database.
string$userTextuser name in database.
Returns:
String: HTML fragment with user talk link

Definition at line 1190 of file Linker.php.

References link(), Title\makeTitle(), and wfMessage().

Referenced by userToolLinks().

static Linker::userToolLinks ( userId,
userText,
redContribsWhenNoEdits = false,
flags = 0,
edits = null 
) [static]

Generate standard user tool links (talk, contributions, block link, etc.)

Parameters:
$userIdInteger: user identifier
string$userTextuser name or IP address
$redContribsWhenNoEditsBoolean: should the contributions link be red if the user has no edits?
$flagsInteger: customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK and Linker::TOOL_LINKS_EMAIL)
$editsInteger: user edit count (optional, for performance)
Returns:
String: HTML fragment

Definition at line 1126 of file Linker.php.

References $attribs, $flags, $user, $wgLang, $wgUser, array(), blockLink(), emailLink(), SpecialPage\getTitleFor(), global, link(), User\newFromId(), TOOL_LINKS_NOBLOCK, userTalkLink(), wfMessage(), and wfRunHooks().

Referenced by BlockListPager\formatValue(), ImageHistoryList\imageHistoryLine(), EnhancedChangesList\recentChangesLine(), revUserTools(), UserrightsPage\showEditUserGroupsForm(), and userToolLinksRedContribs().

static Linker::userToolLinksRedContribs ( userId,
userText,
edits = null 
) [static]

Alias for userToolLinks( $userId, $userText, true );.

Parameters:
$userIdInteger: user identifier
string$userTextuser name or IP address
$editsInteger: user edit count (optional, for performance)
Returns:
String

Definition at line 1181 of file Linker.php.

References userToolLinks().

Referenced by UsersPager\formatRow(), and LogFormatter\makeUserLink().


Member Data Documentation

Linker::$accesskeycache [static]

Definition at line 2130 of file Linker.php.

Linker::$autocommentLocal [static]

Definition at line 1300 of file Linker.php.

Referenced by formatAutocommentsCallback().

Linker::$autocommentTitle [static]

Definition at line 1299 of file Linker.php.

Referenced by formatAutocommentsCallback().

Linker::$commentContextTitle [static]

Definition at line 1386 of file Linker.php.

Referenced by formatLinksInCommentCallback().

Linker::$commentLocal [static]

Definition at line 1387 of file Linker.php.

Definition at line 36 of file Linker.php.

Referenced by UserrightsPage\showEditUserGroupsForm().

Flags for userToolLinks()

Definition at line 35 of file Linker.php.

Referenced by BlockListPager\formatValue(), and userToolLinks().


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