WikiReference Class Reference

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

List of all members.

Public Member Functions

 __construct ($major, $minor, $server, $path)
 getHostname ()
 getDisplayName ()
 Get the the URL in a way to de displayed to the user More or less Wikimedia specific.
 getUrl ($page)
 Get a URL to a page on this foreign wiki.

Private Member Functions

 getLocalUrl ($page)
 Helper function for getUrl().

Private Attributes

 $mMinor
 'en', 'meta', 'mediawiki', etc
 $mMajor
 'wiki', 'wiktionary', etc
 $mServer
 server override, 'www.mediawiki.org'
 $mPath
 path override, '/wiki/$1'


Detailed Description

Reference to a locally-hosted wiki.

Definition at line 101 of file WikiMap.php.


Constructor & Destructor Documentation

WikiReference::__construct ( major,
minor,
server,
path 
)

Definition at line 107 of file WikiMap.php.

References $path.


Member Function Documentation

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 130 of file WikiMap.php.

References $url, and getUrl().

WikiReference::getHostname (  ) 

Definition at line 114 of file WikiMap.php.

WikiReference::getLocalUrl ( page  )  [private]

Helper function for getUrl().

Todo:
FIXME: this may be generalized...
Parameters:
$page String: page name (must be normalised before calling this function!)
Returns:
String: Url fragment

Definition at line 146 of file WikiMap.php.

References $page.

Referenced by getUrl().

WikiReference::getUrl ( page  ) 

Get a URL to a page on this foreign wiki.

Parameters:
$page String: page name (must be normalised before calling this function!)
Returns:
String: Url

Definition at line 156 of file WikiMap.php.

References $page, and getLocalUrl().

Referenced by getDisplayName().


Member Data Documentation

WikiReference::$mMajor [private]

'wiki', 'wiktionary', etc

Definition at line 103 of file WikiMap.php.

WikiReference::$mMinor [private]

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

Definition at line 102 of file WikiMap.php.

WikiReference::$mPath [private]

path override, '/wiki/$1'

Definition at line 105 of file WikiMap.php.

WikiReference::$mServer [private]

server override, 'www.mediawiki.org'

Definition at line 104 of file WikiMap.php.


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