MediaWiki REL1_39
WikiReference Class Reference

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

Public Member Functions

 __construct ( $canonicalServer, $path, $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 26 of file WikiReference.php.

Constructor & Destructor Documentation

◆ __construct()

WikiReference::__construct (   $canonicalServer,
  $path,
  $server = null 
)
Parameters
string$canonicalServer
string$path
null | string$server

Definition at line 36 of file WikiReference.php.

References $path.

Member Function Documentation

◆ getCanonicalServer()

WikiReference::getCanonicalServer ( )

Get a canonical server URL.

Returns
string

Definition at line 96 of file WikiReference.php.

◆ getCanonicalUrl()

WikiReference::getCanonicalUrl (   $page,
  $fragmentId = null 
)

Get a canonical (i.e.

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

Parameters
string$pagePage name (must be normalised before calling this function!)
string | null$fragmentId
Returns
string Url

Definition at line 88 of file WikiReference.php.

Referenced by getUrl().

◆ getDisplayName()

WikiReference::getDisplayName ( )

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

Returns
string

Definition at line 48 of file WikiReference.php.

References wfParseUrl().

◆ getFullUrl()

WikiReference::getFullUrl (   $page,
  $fragmentId = null 
)

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

Parameters
string$pagePage name (must be normalized before calling this function!)
string | null$fragmentId
Returns
string URL

Definition at line 120 of file WikiReference.php.

◆ getUrl()

WikiReference::getUrl (   $page,
  $fragmentId = null 
)

Alias for getCanonicalUrl(), for backwards compatibility.

Parameters
string$page
string | null$fragmentId
Returns
string

Definition at line 107 of file WikiReference.php.

References getCanonicalUrl().


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