WikiReference Class Reference

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

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

Private Member Functions
	getLocalUrl ( $page)
	Helper function for getUrl() More...

Private Attributes
	$mCanonicalServer
	canonical server URL, e.g. 'https://www.mediawiki.org' More...
	$mMajor
	'wiki', 'wiktionary', etc More...
	$mMinor
	'en', 'meta', 'mediawiki', etc More...
	$mPath
	path, '/wiki/$1' More...
	$mServer
	server URL, may be protocol-relative, e.g. '//www.mediawiki.org' More...

Detailed Description

Reference to a locally-hosted wiki.

Definition at line 127 of file WikiMap.php.

Constructor & Destructor Documentation

__construct()

WikiReference::__construct	(		$major,
			$minor,
			$canonicalServer,
			$path,
			$server = null
	)

Parameters

$major	string
$minor	string
$canonicalServer	string
$path	string
$server	null|string

Definition at line 141 of file WikiMap.php.

References $path.

Member Function Documentation

getCanonicalServer()

WikiReference::getCanonicalServer

(

)

Get a canonical server URL.

Returns

string

Definition at line 205 of file WikiMap.php.

References $mCanonicalServer.

getCanonicalUrl()

WikiReference::getCanonicalUrl

(

$page

)

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!)

Returns

String: Url

Definition at line 197 of file WikiMap.php.

References getLocalUrl().

Referenced by getUrl().

getDisplayName()

WikiReference::getDisplayName

(

)

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

Returns

String

Definition at line 169 of file WikiMap.php.

References getUrl(), and wfParseUrl().

getFullUrl()

WikiReference::getFullUrl

(

$page

)

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!)

Returns

String: URL

Definition at line 225 of file WikiMap.php.

References getLocalUrl().

getHostname()

WikiReference::getHostname

(

)

Returns

string

Exceptions

MWException

Definition at line 153 of file WikiMap.php.

References array(), and as.

getLocalUrl()

WikiReference::getLocalUrl (   $page )

private

Helper function for getUrl()

Todo:

FIXME: This may be generalized...

Parameters

string

$page

page name (must be normalised before calling this function!)

Returns

String: Url fragment

Definition at line 187 of file WikiMap.php.

Referenced by getCanonicalUrl(), and getFullUrl().

getUrl()

WikiReference::getUrl

(

$page

)

Alias for getCanonicalUrl(), for backwards compatibility.

Parameters

$page

string

Returns

String

Definition at line 214 of file WikiMap.php.

References getCanonicalUrl().

Referenced by getDisplayName().

Member Data Documentation

$mCanonicalServer

WikiReference::$mCanonicalServer

private

canonical server URL, e.g. 'https://www.mediawiki.org'

Definition at line 130 of file WikiMap.php.

Referenced by getCanonicalServer().

$mMajor

WikiReference::$mMajor

private

'wiki', 'wiktionary', etc

Definition at line 129 of file WikiMap.php.

$mMinor

WikiReference::$mMinor

private

'en', 'meta', 'mediawiki', etc

Definition at line 128 of file WikiMap.php.

$mPath

WikiReference::$mPath

private

path, '/wiki/$1'

Definition at line 132 of file WikiMap.php.

$mServer

WikiReference::$mServer

private

server URL, may be protocol-relative, e.g. '//www.mediawiki.org'

Definition at line 131 of file WikiMap.php.

---

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

• includes/WikiMap.php