MediaWiki REL1_30
|
Class that generates HTML links for pages. More...
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 |
Class that generates HTML links for pages.
Definition at line 42 of file LinkRenderer.php.
MediaWiki\Linker\LinkRenderer::__construct | ( | TitleFormatter | $titleFormatter, |
LinkCache | $linkCache ) |
TitleFormatter | $titleFormatter | |
LinkCache | $linkCache |
Definition at line 84 of file LinkRenderer.php.
References MediaWiki\Linker\LinkRenderer\$linkCache, and MediaWiki\Linker\LinkRenderer\$titleFormatter.
|
private |
Builds the final element.
LinkTarget | $target | |
string | HtmlArmor | $text | |
array | $attribs | |
bool | $isKnown |
Definition at line 361 of file LinkRenderer.php.
References $attribs, $html, $options, $ret, HtmlArmor\getHtml(), MediaWiki\Linker\LinkRenderer\getLegacyOptions(), Title\newFromLinkTarget(), and Html\rawElement().
Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().
MediaWiki\Linker\LinkRenderer::getExpandURLs | ( | ) |
Definition at line 113 of file LinkRenderer.php.
References MediaWiki\Linker\LinkRenderer\$expandUrls.
MediaWiki\Linker\LinkRenderer::getForceArticlePath | ( | ) |
Definition at line 99 of file LinkRenderer.php.
References MediaWiki\Linker\LinkRenderer\$forceArticlePath.
|
private |
Get the options in the legacy format.
bool | $isKnown | Whether the link is known or broken |
Definition at line 162 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().
MediaWiki\Linker\LinkRenderer::getLinkClasses | ( | LinkTarget | $target | ) |
Return the CSS classes of a known link.
LinkTarget | $target |
Definition at line 461 of file LinkRenderer.php.
References MediaWiki\Linker\LinkTarget\getNamespace(), and MWNamespace\isContent().
Referenced by MediaWiki\Linker\LinkRenderer\makeKnownLink().
|
private |
LinkTarget | $target |
Definition at line 390 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().
|
private |
Definition at line 401 of file LinkRenderer.php.
References $query, Title\newFromLinkTarget(), and wfAppendQuery().
Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().
MediaWiki\Linker\LinkRenderer::getStubThreshold | ( | ) |
Definition at line 127 of file LinkRenderer.php.
References MediaWiki\Linker\LinkRenderer\$stubThreshold.
MediaWiki\Linker\LinkRenderer::makeBrokenLink | ( | LinkTarget | $target, |
$text = null, | |||
array | $extraAttribs = [], | ||
array | $query = [] ) |
LinkTarget | $target | |
string | HtmlArmor | null | $text | |
array | $extraAttribs | |
array | $query |
Definition at line 310 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().
MediaWiki\Linker\LinkRenderer::makeKnownLink | ( | LinkTarget | $target, |
$text = null, | |||
array | $extraAttribs = [], | ||
array | $query = [] ) |
LinkTarget | $target | |
string | HtmlArmor | null | $text | |
array | $extraAttribs | |
array | $query |
Definition at line 282 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(), LogEventsList\getFilterLinks(), and MediaWiki\Linker\LinkRenderer\makeLink().
MediaWiki\Linker\LinkRenderer::makeLink | ( | LinkTarget | $target, |
$text = null, | |||
array | $extraAttribs = [], | ||
array | $query = [] ) |
LinkTarget | $target | |
string | HtmlArmor | null | $text | |
array | $extraAttribs | |
array | $query |
Definition at line 145 of file LinkRenderer.php.
References $query, MediaWiki\Linker\LinkRenderer\makeBrokenLink(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), and Title\newFromLinkTarget().
Referenced by ProtectLogFormatter\getActionLinks().
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.
LinkTarget | $target | |
string | HtmlArmor | null | $text | |
string | $classes | CSS classes to add |
array | $extraAttribs | |
array | $query |
Definition at line 248 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().
|
private |
Merges two sets of attributes.
array | $defaults | |
array | $attribs |
Definition at line 438 of file LinkRenderer.php.
References $attribs, $ret, and Sanitizer\mergeAttributes().
Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().
|
private |
Normalizes the provided target.
LinkTarget | $target |
Definition at line 426 of file LinkRenderer.php.
References Linker\normaliseSpecialPage().
Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().
|
private |
Definition at line 178 of file LinkRenderer.php.
References $query, $ret, and MediaWiki\Linker\LinkRenderer\runLegacyBeginHook().
Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink(), and MediaWiki\Linker\LinkRenderer\makePreloadedLink().
|
private |
Definition at line 190 of file LinkRenderer.php.
References $html, $options, $query, $ret, HtmlArmor\getHtml(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Linker\LinkRenderer\getLegacyOptions(), Title\newFromLinkTarget(), and MediaWiki\Linker\LinkRenderer\runLegacyBeginHook().
Referenced by MediaWiki\Linker\LinkRenderer\runBeginHook(), MediaWiki\Linker\LinkRenderer\runLegacyBeginHook(), and MediaWiki\Linker\LinkRenderer\setRunLegacyBeginHook().
MediaWiki\Linker\LinkRenderer::setExpandURLs | ( | $expand | ) |
string | bool | int | $expand | A PROTO_* constant or false |
Definition at line 106 of file LinkRenderer.php.
References $expand.
MediaWiki\Linker\LinkRenderer::setForceArticlePath | ( | $force | ) |
bool | $force |
Definition at line 92 of file LinkRenderer.php.
MediaWiki\Linker\LinkRenderer::setRunLegacyBeginHook | ( | $run | ) |
bool | $run |
Definition at line 134 of file LinkRenderer.php.
References $run, and MediaWiki\Linker\LinkRenderer\runLegacyBeginHook().
MediaWiki\Linker\LinkRenderer::setStubThreshold | ( | $threshold | ) |
int | $threshold |
Definition at line 120 of file LinkRenderer.php.
|
private |
A PROTO_* constant or false.
Definition at line 56 of file LinkRenderer.php.
Referenced by MediaWiki\Linker\LinkRenderer\getExpandURLs().
|
private |
Whether to force the pretty article path.
Definition at line 49 of file LinkRenderer.php.
Referenced by MediaWiki\Linker\LinkRenderer\getForceArticlePath().
|
private |
Definition at line 71 of file LinkRenderer.php.
Referenced by MediaWiki\Linker\LinkRenderer\__construct().
|
private |
Whether to run the legacy Linker hooks.
Definition at line 78 of file LinkRenderer.php.
|
private |
Definition at line 61 of file LinkRenderer.php.
Referenced by MediaWiki\Linker\LinkRenderer\getLegacyOptions(), and MediaWiki\Linker\LinkRenderer\getStubThreshold().
|
private |
Definition at line 66 of file LinkRenderer.php.
Referenced by MediaWiki\Linker\LinkRenderer\__construct().