public interface Sites
SiteLink
objects. These associations are part of the
configuration of a MediaWiki site and therefore not fixed.
This is not a Wikibase data object as such, but part of the general configuration of a Wikibase site. The interface supports modification, e.g., to insert additional associations. This can be useful to augment data manually (even when loading most of the data from a file dump). For example, some of Wikimedia's data exports are more frequent than their sites table exports, so it might be useful to add some very recent sites.
Modifier and Type | Method and Description |
---|---|
String |
getFileUrl(String siteKey,
String fileName)
Returns the URL for the file of the given name, or null if the site is
not known.
|
String |
getGroup(String siteKey)
Returns the group for the given site, or null if there is no such data
for this site key.
|
String |
getLanguageCode(String siteKey)
Returns the MediaWiki language code for the given site, or null if there
is no such data for this site key.
|
String |
getPageUrl(String siteKey,
String pageTitle)
Returns the URL for the page of the given name, or null if the site is
not known.
|
String |
getSiteLinkUrl(SiteLink siteLink)
Returns the URL for the given site link, or null if its site key is not
known.
|
String |
getSiteType(String siteKey)
Returns the type for the given site, or null if there is no such data for
this site key.
|
void |
setSiteInformation(String siteKey,
String group,
String languageCode,
String siteType,
String filePath,
String pagePath)
Sets the stored information for the site of the given key to the given
values.
|
void setSiteInformation(String siteKey, String group, String languageCode, String siteType, String filePath, String pagePath)
Note that the path URLs given here should be absolute. In MediaWiki, it is common to use protocol-relative paths (starting with "//" rather than with "http://" or "https://"). The code in this class is not prepared to handle this yet (URL-returning methods would need to allow for a preferred protocol to be specified).
siteKey
- the global site key, e.g., "enwiki" or "fawikivoyage"group
- the site group, e.g., "wikipedia" or "wikivoyage"languageCode
- the site MediaWiki language code, e.g., "en" or "fa"siteType
- the site type, typically "mediawiki"filePath
- the file path with $1 as a placeholder for the file name,
e.g., "http://en.wikipedia.org/w/$1" or
"http://fa.wikivoyage.org/w/$1"pagePath
- the page path with $1 as a placeholder for the page title,
e.g., "http://en.wikipedia.org/wiki/$1" or
"http://fa.wikivoyage.org/wiki/$1"String getLanguageCode(String siteKey)
The language code follows the MediaWiki conventions for language codes, which do not follow any standard. Most codes agree with those in BCP 47 , but there are a number of exceptions.
siteKey
- the global site keyString getGroup(String siteKey)
siteKey
- the global site keyString getPageUrl(String siteKey, String pageTitle)
siteKey
- the global site keypageTitle
- the title of the page, including namespace prefixes if anyString getSiteLinkUrl(SiteLink siteLink)
siteLink
- the SiteLink objectString getFileUrl(String siteKey, String fileName)
siteKey
- the global site keyfileName
- the name of the fileCopyright © 2014–2024 Wikidata Toolkit Developers. Generated from source code published under the Apache License 2.0. For more information, see the Wikidata Toolkit homepage