WikiMap Class Reference

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

List of all members.

Static Public Member Functions

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


Detailed Description

Helper tools for dealing with other locally-hosted wikis.

Definition at line 6 of file WikiMap.php.


Member Function Documentation

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

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

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

Definition at line 55 of file WikiMap.php.

References makeForeignLink().

Referenced by LogPage::getTitleLink().

static WikiMap::getForeignURL ( wikiID,
page 
) [static]

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

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

Definition at line 88 of file WikiMap.php.

References $page, and getWiki().

Referenced by makeForeignLink().

static WikiMap::getWiki ( wikiID  )  [static]

Get a WikiReference object for $wikiID.

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

Definition at line 14 of file WikiMap.php.

References $IP, and $path.

Referenced by getForeignURL(), and 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:
$wikiID String: wiki'd id (generally database name)
Returns:
Wiki's name or $wiki_id if the wiki was not found

Definition at line 38 of file WikiMap.php.

References getWiki().

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

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

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

Definition at line 67 of file WikiMap.php.

References $page, $url, $wgUser, and getForeignURL().

Referenced by foreignUserLink().


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

Generated on Sat Apr 30 22:57:53 2011 for MediaWiki by  doxygen 1.5.9