A service for generating links from page titles. More...

Inheritance diagram for MediaWikiPageLinkRenderer:

Collaboration diagram for MediaWikiPageLinkRenderer:

Public Member Functions
	__construct (TitleFormatter $formatter, $baseUrl=null)
	getPageUrl (TitleValue $page, $params=array())
	Returns the (partial) URL for the given page (including any section identifier).
	renderHtmlLink (TitleValue $page, $text=null)
	Returns an HTML link to the given page, using the given surface text.
	renderWikitextLink (TitleValue $page, $text=null)
	Returns a wikitext link to the given page, using the given surface text.
Protected Attributes
string	$baseUrl
TitleFormatter	$formatter

Detailed Description

A service for generating links from page titles.

Constructor & Destructor Documentation

MediaWikiPageLinkRenderer::__construct	(	TitleFormatter $	formatter,
		$	baseUrl = `null`
	)

Note:: $formatter and $baseUrl are currently not used for generating links, since we still rely on the Linker class to generate the actual HTML. Once this is reversed so that Linker becomes a legacy interface to HtmlPageLinkRenderer, we will be using them, so it seems prudent to already declare the dependency and inject them.

Parameters:

TitleFormatter	$formatter	Formatter for generating the target title string
string	$baseUrl	(currently unused, pending refactoring of Linker). Defaults to $wgArticlePath.

MediaWikiPageLinkRenderer::getPageUrl	(	TitleValue $	page,
		$	params = `array()`
	)

Returns the (partial) URL for the given page (including any section identifier).

Parameters:

TitleValue	$page	The link's target
array	$params	Any additional URL parameters.

MediaWikiPageLinkRenderer::renderHtmlLink	(	TitleValue $	page,
		$	text = `null`
	)

Returns an HTML link to the given page, using the given surface text.

Parameters:

TitleValue	$page	The link's target
string	$text	The link's surface text (will be derived from $page if not given).

MediaWikiPageLinkRenderer::renderWikitextLink	(	TitleValue $	page,
		$	text = `null`
	)

Returns a wikitext link to the given page, using the given surface text.

Parameters:

TitleValue	$page	The link's target
string	$text	The link's surface text (will be derived from $page if not given).

string MediaWikiPageLinkRenderer::$baseUrl [protected]

TitleFormatter MediaWikiPageLinkRenderer::$formatter [protected]

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