Class that generates HTML links for pages. More...

Collaboration diagram for MediaWiki\Linker\LinkRenderer:

[legend]

Public Member Functions
	__construct (TitleFormatter $titleFormatter, LinkCache $linkCache)

	getExpandURLs ()

	getForceArticlePath ()

	getLinkClasses (LinkTarget $target)
	Return the CSS classes of a known link.

	getStubThreshold ()

	makeBrokenLink (LinkTarget $target, $text=null, array $extraAttribs=[], array $query=[])

	makeKnownLink (LinkTarget $target, $text=null, array $extraAttribs=[], array $query=[])

	makeLink (LinkTarget $target, $text=null, array $extraAttribs=[], array $query=[])

	makePreloadedLink (LinkTarget $target, $text=null, $classes='', array $extraAttribs=[], array $query=[])
	If you have already looked up the proper CSS classes using LinkRenderer::getLinkClasses() or some other method, use this to avoid looking it up again.

	setExpandURLs ( $expand)

	setForceArticlePath ( $force)

	setRunLegacyBeginHook ( $run)

	setStubThreshold ( $threshold)

Private Member Functions
	buildAElement (LinkTarget $target, $text, array $attribs, $isKnown)
	Builds the final element.

	getLegacyOptions ( $isKnown)
	Get the options in the legacy format.

	getLinkText (LinkTarget $target)

	getLinkURL (LinkTarget $target, array $query=[])

	mergeAttribs ( $defaults, $attribs)
	Merges two sets of attributes.

	normalizeTarget (LinkTarget $target)
	Normalizes the provided target.

	runBeginHook (LinkTarget $target, &$text, &$extraAttribs, &$query, $isKnown)

	runLegacyBeginHook (LinkTarget $target, &$text, &$extraAttribs, &$query, $isKnown)

Private Attributes
string bool int	$expandUrls = false
	A PROTO_* constant or false.

bool	$forceArticlePath = false
	Whether to force the pretty article path.

LinkCache	$linkCache

bool	$runLegacyBeginHook = true
	Whether to run the legacy Linker hooks.

int	$stubThreshold = 0

TitleFormatter	$titleFormatter

Detailed Description

Class that generates HTML links for pages.

See also: https://www.mediawiki.org/wiki/Manual:LinkRenderer

Since: 1.28

Definition at line 41 of file LinkRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Linker\LinkRenderer::__construct	(	TitleFormatter	$titleFormatter,
		LinkCache	$linkCache
	)

Parameters

TitleFormatter	$titleFormatter
LinkCache	$linkCache

Definition at line 83 of file LinkRenderer.php.

References MediaWiki\Linker\LinkRenderer\$linkCache, and MediaWiki\Linker\LinkRenderer\$titleFormatter.

Member Function Documentation

◆ buildAElement()

MediaWiki\Linker\LinkRenderer::buildAElement	(	LinkTarget	$target,
			$text,
		array	$attribs,
			$isKnown
	)

private

Builds the final element.

Parameters

LinkTarget	$target
string \| HtmlArmor	$text
array	$attribs
bool	$isKnown

Returns: null|string

Definition at line 360 of file LinkRenderer.php.

References $attribs, $html, $options, $ret, $title, HtmlArmor\getHtml(), and MediaWiki\Linker\LinkRenderer\getLegacyOptions().

Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().

◆ getExpandURLs()

MediaWiki\Linker\LinkRenderer::getExpandURLs ( )

Returns: string|bool|int a PROTO_* constant or false

Definition at line 112 of file LinkRenderer.php.

References MediaWiki\Linker\LinkRenderer\$expandUrls.

◆ getForceArticlePath()

MediaWiki\Linker\LinkRenderer::getForceArticlePath ( )

Returns: bool

Definition at line 98 of file LinkRenderer.php.

References MediaWiki\Linker\LinkRenderer\$forceArticlePath.

◆ getLegacyOptions()

MediaWiki\Linker\LinkRenderer::getLegacyOptions ( $isKnown )

private

Get the options in the legacy format.

Parameters

bool $isKnown Whether the link is known or broken

Returns: array

Definition at line 161 of file LinkRenderer.php.

References $options, MediaWiki\Linker\LinkRenderer\$stubThreshold, PROTO_HTTP, and PROTO_HTTPS.

Referenced by MediaWiki\Linker\LinkRenderer\buildAElement(), and MediaWiki\Linker\LinkRenderer\runLegacyBeginHook().

◆ getLinkClasses()

MediaWiki\Linker\LinkRenderer::getLinkClasses ( LinkTarget $target )

Return the CSS classes of a known link.

Parameters

LinkTarget $target

Returns: string CSS class

Definition at line 460 of file LinkRenderer.php.

References MediaWiki\Linker\LinkTarget\getNamespace().

Referenced by MediaWiki\Linker\LinkRenderer\makeKnownLink().

◆ getLinkText()

MediaWiki\Linker\LinkRenderer::getLinkText ( LinkTarget $target )

private

Parameters

LinkTarget $target

Returns: string non-escaped text

Definition at line 389 of file LinkRenderer.php.

References MediaWiki\Linker\LinkTarget\getFragment(), and MediaWiki\Linker\LinkTarget\hasFragment().

Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().

◆ getLinkURL()

MediaWiki\Linker\LinkRenderer::getLinkURL	(	LinkTarget	$target,
		array	$query = `[]`
	)

private

Definition at line 400 of file LinkRenderer.php.

References $query, $title, and wfAppendQuery().

Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().

◆ getStubThreshold()

MediaWiki\Linker\LinkRenderer::getStubThreshold ( )

Returns: int

Definition at line 126 of file LinkRenderer.php.

References MediaWiki\Linker\LinkRenderer\$stubThreshold.

◆ makeBrokenLink()

MediaWiki\Linker\LinkRenderer::makeBrokenLink	(	LinkTarget	$target,
			$text = `null`,
		array	$extraAttribs = `[]`,
		array	$query = `[]`
	)

Parameters

LinkTarget	$target
string \| HtmlArmor \| null	$text
array	$extraAttribs
array	$query

Returns: string

Definition at line 309 of file LinkRenderer.php.

References $attribs, $query, $ret, MediaWiki\Linker\LinkRenderer\buildAElement(), MediaWiki\Linker\LinkTarget\createFragmentTarget(), MediaWiki\Linker\LinkRenderer\getLinkText(), MediaWiki\Linker\LinkRenderer\getLinkURL(), MediaWiki\Linker\LinkTarget\getNamespace(), MediaWiki\Linker\LinkTarget\hasFragment(), MediaWiki\Linker\LinkRenderer\mergeAttribs(), MediaWiki\Linker\LinkRenderer\normalizeTarget(), NS_SPECIAL, MediaWiki\Linker\LinkRenderer\runBeginHook(), and wfMessage().

Referenced by MediaWiki\Linker\LinkRenderer\makeLink().

◆ makeKnownLink()

MediaWiki\Linker\LinkRenderer::makeKnownLink	(	LinkTarget	$target,
			$text = `null`,
		array	$extraAttribs = `[]`,
		array	$query = `[]`
	)

Parameters

LinkTarget	$target
string \| HtmlArmor \| null	$text
array	$extraAttribs
array	$query

Returns: string

Definition at line 281 of file LinkRenderer.php.

References $query, MediaWiki\Linker\LinkRenderer\getLinkClasses(), MediaWiki\Linker\LinkTarget\isExternal(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().

Referenced by BlockLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), ProtectLogFormatter\getActionLinks(), and MediaWiki\Linker\LinkRenderer\makeLink().

◆ makeLink()

MediaWiki\Linker\LinkRenderer::makeLink	(	LinkTarget	$target,
			$text = `null`,
		array	$extraAttribs = `[]`,
		array	$query = `[]`
	)

Parameters

LinkTarget	$target
string \| HtmlArmor \| null	$text
array	$extraAttribs
array	$query

Returns: string

Definition at line 144 of file LinkRenderer.php.

References $query, $title, MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makeKnownLink().

Referenced by ProtectLogFormatter\getActionLinks().

◆ makePreloadedLink()

MediaWiki\Linker\LinkRenderer::makePreloadedLink	(	LinkTarget	$target,
			$text = `null`,
			$classes = `''`,
		array	$extraAttribs = `[]`,
		array	$query = `[]`
	)

If you have already looked up the proper CSS classes using LinkRenderer::getLinkClasses() or some other method, use this to avoid looking it up again.

Parameters

LinkTarget	$target
string \| HtmlArmor \| null	$text
string	$classes	CSS classes to add
array	$extraAttribs
array	$query

Returns: string

Definition at line 247 of file LinkRenderer.php.

References $attribs, $query, $ret, MediaWiki\Linker\LinkRenderer\buildAElement(), MediaWiki\Linker\LinkRenderer\getLinkText(), MediaWiki\Linker\LinkRenderer\getLinkURL(), MediaWiki\Linker\LinkRenderer\mergeAttribs(), MediaWiki\Linker\LinkRenderer\normalizeTarget(), and MediaWiki\Linker\LinkRenderer\runBeginHook().

Referenced by MediaWiki\Linker\LinkRenderer\makeKnownLink().

◆ mergeAttribs()

MediaWiki\Linker\LinkRenderer::mergeAttribs	(	$defaults,
		$attribs
	)

private

Merges two sets of attributes.

Parameters

array	$defaults
array	$attribs

Returns: array

Definition at line 437 of file LinkRenderer.php.

References $attribs, $ret, and as.

Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().

◆ normalizeTarget()

MediaWiki\Linker\LinkRenderer::normalizeTarget ( LinkTarget $target )

private

Normalizes the provided target.

Todo:: move the code from Linker actually here

Parameters

LinkTarget $target

Returns: LinkTarget

Definition at line 425 of file LinkRenderer.php.

References Linker\normaliseSpecialPage().

Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().

◆ runBeginHook()

MediaWiki\Linker\LinkRenderer::runBeginHook	(	LinkTarget	$target,
		&	$text,
		&	$extraAttribs,
		&	$query,
			$isKnown
	)

private

Definition at line 177 of file LinkRenderer.php.

References $query, $ret, and MediaWiki\Linker\LinkRenderer\runLegacyBeginHook().

Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().

◆ runLegacyBeginHook()

MediaWiki\Linker\LinkRenderer::runLegacyBeginHook	(	LinkTarget	$target,
		&	$text,
		&	$extraAttribs,
		&	$query,
			$isKnown
	)

private

Definition at line 189 of file LinkRenderer.php.

References $html, $options, $query, $ret, $title, HtmlArmor\getHtml(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Linker\LinkRenderer\getLegacyOptions(), and MediaWiki\Linker\LinkRenderer\runLegacyBeginHook().

Referenced by MediaWiki\Linker\LinkRenderer\runBeginHook(), MediaWiki\Linker\LinkRenderer\runLegacyBeginHook(), and MediaWiki\Linker\LinkRenderer\setRunLegacyBeginHook().

◆ setExpandURLs()

MediaWiki\Linker\LinkRenderer::setExpandURLs ( $expand )

Parameters

string | bool | int $expand A PROTO_* constant or false

Definition at line 105 of file LinkRenderer.php.

References $expand.

◆ setForceArticlePath()

MediaWiki\Linker\LinkRenderer::setForceArticlePath ( $force )

Parameters

bool $force

Definition at line 91 of file LinkRenderer.php.

◆ setRunLegacyBeginHook()

MediaWiki\Linker\LinkRenderer::setRunLegacyBeginHook ( $run )

Parameters

bool $run

Definition at line 133 of file LinkRenderer.php.

References $run, and MediaWiki\Linker\LinkRenderer\runLegacyBeginHook().

◆ setStubThreshold()

MediaWiki\Linker\LinkRenderer::setStubThreshold ( $threshold )

Parameters

int $threshold

Definition at line 119 of file LinkRenderer.php.

Member Data Documentation

◆ $expandUrls

string bool int MediaWiki\Linker\LinkRenderer::$expandUrls = false

private

A PROTO_* constant or false.

Definition at line 55 of file LinkRenderer.php.

Referenced by MediaWiki\Linker\LinkRenderer\getExpandURLs().

◆ $forceArticlePath

bool MediaWiki\Linker\LinkRenderer::$forceArticlePath = false

private

Whether to force the pretty article path.

Definition at line 48 of file LinkRenderer.php.

Referenced by MediaWiki\Linker\LinkRenderer\getForceArticlePath().

◆ $linkCache

LinkCache MediaWiki\Linker\LinkRenderer::$linkCache

private

Definition at line 70 of file LinkRenderer.php.

Referenced by MediaWiki\Linker\LinkRenderer\__construct().

◆ $runLegacyBeginHook

bool MediaWiki\Linker\LinkRenderer::$runLegacyBeginHook = true

private

Whether to run the legacy Linker hooks.

Definition at line 77 of file LinkRenderer.php.

◆ $stubThreshold

int MediaWiki\Linker\LinkRenderer::$stubThreshold = 0

private

Definition at line 60 of file LinkRenderer.php.

Referenced by MediaWiki\Linker\LinkRenderer\getLegacyOptions(), and MediaWiki\Linker\LinkRenderer\getStubThreshold().

◆ $titleFormatter

TitleFormatter MediaWiki\Linker\LinkRenderer::$titleFormatter

private

Definition at line 65 of file LinkRenderer.php.

Referenced by MediaWiki\Linker\LinkRenderer\__construct().

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

includes/linker/LinkRenderer.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildAElement()

◆ getExpandURLs()

◆ getForceArticlePath()

◆ getLegacyOptions()

◆ getLinkClasses()

◆ getLinkText()

◆ getLinkURL()

◆ getStubThreshold()

◆ makeBrokenLink()

◆ makeKnownLink()

◆ makeLink()

◆ makePreloadedLink()

◆ mergeAttribs()

◆ normalizeTarget()

◆ runBeginHook()

◆ runLegacyBeginHook()

◆ setExpandURLs()

◆ setForceArticlePath()

◆ setRunLegacyBeginHook()

◆ setStubThreshold()

Member Data Documentation

◆ $expandUrls

◆ $forceArticlePath

◆ $linkCache

◆ $runLegacyBeginHook

◆ $stubThreshold

◆ $titleFormatter