| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Tools for dealing with other locally-hosted wikis. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
| File Size: | 229 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 2 times |
| Includes or requires: | 0 files |
WikiMap:: (5 methods):
getWiki()
getWikiName()
foreignUserLink()
makeForeignLink()
getForeignURL()
WikiReference:: (8 methods):
__construct()
getHostname()
getDisplayName()
getLocalUrl()
getCanonicalUrl()
getCanonicalServer()
getUrl()
getFullUrl()
| getWiki( $wikiID ) X-Ref |
| Get a WikiReference object for $wikiID param: string $wikiID Wiki'd id (generally database name) return: WikiReference|null WikiReference object or null if the wiki was not found |
| getWikiName( $wikiID ) X-Ref |
| Convenience to get the wiki's display name param: string $wikiID Wiki'd id (generally database name) return: string|int Wiki's name or $wiki_id if the wiki was not found |
| foreignUserLink( $wikiID, $user, $text = null ) X-Ref |
| Convenience to get a link to a user page on a foreign wiki param: string $wikiID Wiki'd id (generally database name) param: string $user User name (must be normalised before calling this function!) param: string $text Link's text; optional, default to "User:$user" return: string HTML link or false if the wiki was not found |
| makeForeignLink( $wikiID, $page, $text = null ) X-Ref |
| Convenience to get a link to a page on a foreign wiki param: string $wikiID Wiki'd id (generally database name) param: string $page Page name (must be normalised before calling this function!) param: string $text Link's text; optional, default to $page return: string HTML link or false if the wiki was not found |
| getForeignURL( $wikiID, $page ) X-Ref |
| Convenience to get a url to a page on a foreign wiki param: string $wikiID Wiki'd id (generally database name) param: string $page Page name (must be normalised before calling this function!) return: string|bool URL or false if the wiki was not found |
Class: WikiReference - X-Ref
Reference to a locally-hosted wiki| __construct( $major, $minor, $canonicalServer, $path, $server = null ) X-Ref |
param: string $major param: string $minor param: string $canonicalServer param: string $path param: null|string $server |
| getHostname() X-Ref |
return: string |
| getDisplayName() X-Ref |
| Get the the URL in a way to de displayed to the user More or less Wikimedia specific return: string |
| getLocalUrl( $page ) X-Ref |
| Helper function for getUrl() param: string $page Page name (must be normalised before calling this function!) return: string Url fragment |
| getCanonicalUrl( $page ) X-Ref |
| Get a canonical (i.e. based on $wgCanonicalServer) URL to a page on this foreign wiki param: string $page Page name (must be normalised before calling this function!) return: string Url |
| getCanonicalServer() X-Ref |
| Get a canonical server URL return: string |
| getUrl( $page ) X-Ref |
| Alias for getCanonicalUrl(), for backwards compatibility. param: string $page return: string |
| getFullUrl( $page ) X-Ref |
| Get a URL based on $wgServer, like Title::getFullURL() would produce when called locally on the wiki. param: string $page Page name (must be normalized before calling this function!) return: string URL |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |