MediaWiki\WikiMap\WikiReference Class Reference

Reference to a locally-hosted wiki. More...

Public Member Functions
	__construct (string $canonicalServer, string $path, ?string $server=null)
	getCanonicalServer ()
	Get a canonical server URL.
	getCanonicalUrl ( $page, $fragmentId=null)
	Get a canonical (i.e.
	getDisplayName ()
	Get the URL in a way to be displayed to the user More or less Wikimedia specific.
	getFullUrl ( $page, $fragmentId=null)
	Get a URL based on $wgServer, like Title::getFullURL() would produce when called locally on the wiki.
	getUrl ( $page, $fragmentId=null)
	Alias for getCanonicalUrl(), for backwards compatibility.

Detailed Description

Reference to a locally-hosted wiki.

Definition at line 28 of file WikiReference.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\WikiMap\WikiReference::__construct	(	string	$canonicalServer,
		string	$path,
		?string	$server = null )

Parameters

string	$canonicalServer
string	$path
null | string	$server

Definition at line 41 of file WikiReference.php.

References $path.

Member Function Documentation

getCanonicalServer()

MediaWiki\WikiMap\WikiReference::getCanonicalServer

(

)

Get a canonical server URL.

Returns

string

Definition at line 101 of file WikiReference.php.

getCanonicalUrl()

MediaWiki\WikiMap\WikiReference::getCanonicalUrl	(		$page,
			$fragmentId = null )

Get a canonical (i.e.

based on $wgCanonicalServer) URL to a page on this foreign wiki

Parameters

string	$page	Page name (must be normalised before calling this function!)
string | null	$fragmentId

Returns

string Url

Definition at line 93 of file WikiReference.php.

Referenced by MediaWiki\WikiMap\WikiReference\getUrl().

getDisplayName()

MediaWiki\WikiMap\WikiReference::getDisplayName

(

)

Get the URL in a way to be displayed to the user More or less Wikimedia specific.

Returns

string

Definition at line 53 of file WikiReference.php.

getFullUrl()

MediaWiki\WikiMap\WikiReference::getFullUrl	(		$page,
			$fragmentId = null )

Get a URL based on $wgServer, like Title::getFullURL() would produce when called locally on the wiki.

Parameters

string	$page	Page name (must be normalized before calling this function!)
string | null	$fragmentId

Returns

string URL

Definition at line 125 of file WikiReference.php.

getUrl()

MediaWiki\WikiMap\WikiReference::getUrl	(		$page,
			$fragmentId = null )

Alias for getCanonicalUrl(), for backwards compatibility.

Parameters

string	$page
string | null	$fragmentId

Returns

string

Definition at line 112 of file WikiReference.php.

References MediaWiki\WikiMap\WikiReference\getCanonicalUrl().

---

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

• includes/WikiMap/WikiReference.php