MediaWiki  1.23.2
WikiMap Class Reference

Helper tools for dealing with other locally-hosted wikis. More...

Static Public Member Functions

static foreignUserLink ( $wikiID, $user, $text=null)
 Convenience to get a link to a user page on a foreign wiki. More...
 
static getForeignURL ( $wikiID, $page)
 Convenience to get a url to a page on a foreign wiki. More...
 
static getWiki ( $wikiID)
 Get a WikiReference object for $wikiID. More...
 
static getWikiName ( $wikiID)
 Convenience to get the wiki's display name. More...
 
static makeForeignLink ( $wikiID, $page, $text=null)
 Convenience to get a link to a page on a foreign wiki. More...
 

Detailed Description

Helper tools for dealing with other locally-hosted wikis.

Definition at line 26 of file WikiMap.php.

Member Function Documentation

◆ foreignUserLink()

static WikiMap::foreignUserLink (   $wikiID,
  $user,
  $text = null 
)
static

Convenience to get a link to a user page on a foreign wiki.

Parameters
string$wikiIDwiki'd id (generally database name)
string$useruser name (must be normalised before calling this function!)
string$textlink's text; optional, default to "User:$user"
Returns
String: HTML link or false if the wiki was not found

Definition at line 81 of file WikiMap.php.

References makeForeignLink().

Referenced by RightsLogFormatter\makePageLink().

◆ getForeignURL()

static WikiMap::getForeignURL (   $wikiID,
  $page 
)
static

Convenience to get a url to a page on a foreign wiki.

Parameters
string$wikiIDwiki'd id (generally database name)
string$pagepage name (must be normalised before calling this function!)
Returns
String: URL or false if the wiki was not found

Definition at line 113 of file WikiMap.php.

References getWiki().

Referenced by makeForeignLink().

◆ getWiki()

static WikiMap::getWiki (   $wikiID)
static

Get a WikiReference object for $wikiID.

Parameters
string$wikiIDwiki'd id (generally database name)
Returns
WikiReference object or null if the wiki was not found

Definition at line 34 of file WikiMap.php.

References $path, array(), global, and list.

Referenced by getForeignURL(), and getWikiName().

◆ getWikiName()

static WikiMap::getWikiName (   $wikiID)
static

Convenience to get the wiki's display name.

Todo:
We can give more info than just the wiki id!
Parameters
string$wikiIDwiki'd id (generally database name)
Returns
string|int Wiki's name or $wiki_id if the wiki was not found

Definition at line 64 of file WikiMap.php.

References getWiki().

◆ makeForeignLink()

static WikiMap::makeForeignLink (   $wikiID,
  $page,
  $text = null 
)
static

Convenience to get a link to a page on a foreign wiki.

Parameters
string$wikiIDwiki'd id (generally database name)
string$pagepage name (must be normalised before calling this function!)
string$textlink's text; optional, default to $page
Returns
String: HTML link or false if the wiki was not found

Definition at line 93 of file WikiMap.php.

References getForeignURL(), and Linker\makeExternalLink().

Referenced by foreignUserLink().


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