MediaWiki
1.30.0
|
Public Member Functions | |
__construct ( $type=self::TYPE_UNKNOWN) | |
addInterwikiId ( $identifier) | |
Adds an interwiki id to the site. More... | |
addLocalId ( $type, $identifier) | |
Adds a local identifier. More... | |
addNavigationId ( $identifier) | |
Adds a navigation id to the site. More... | |
getAllPaths () | |
Returns the paths as associative array. More... | |
getDomain () | |
Returns the domain of the site, ie en.wikipedia.org Or false if it's not known. More... | |
getExtraConfig () | |
Returns the type specific config. More... | |
getExtraData () | |
Returns the type specific fields. More... | |
getGlobalId () | |
Returns the global site identifier (ie enwiktionary). More... | |
getGroup () | |
Gets the group of the site (ie wikipedia). More... | |
getInternalId () | |
Returns the set internal identifier for the site. More... | |
getInterwikiIds () | |
Returns the interwiki link identifiers that can be used for this site. More... | |
getLanguageCode () | |
Returns language code of the sites primary language. More... | |
getLinkPath () | |
Returns the path used to construct links with or false if there is no such path. More... | |
getLinkPathType () | |
Returns the main path type, that is the type of the path that should generally be used to construct links to the target site. More... | |
getLocalIds () | |
Returns all local ids. More... | |
getNavigationIds () | |
Returns the equivalent link identifiers that can be used to make the site show up in interfaces such as the "language links" section. More... | |
getPageUrl ( $pageName=false) | |
Returns the full URL for the given page on the site. More... | |
getPath ( $pathType) | |
Returns the path of the provided type or false if there is no such path. More... | |
getProtocol () | |
Returns the protocol of the site. More... | |
getSource () | |
Returns the source of the site data (ie 'local', 'wikidata', 'my-magical-repo'). More... | |
getType () | |
Returns the type of the site (ie mediawiki). More... | |
normalizePageName ( $pageName) | |
Returns $pageName without changes. More... | |
removePath ( $pathType) | |
Removes the path of the provided type if it's set. More... | |
serialize () | |
setExtraConfig (array $extraConfig) | |
Sets the type specific config. More... | |
setExtraData (array $extraData) | |
Sets the type specific fields. More... | |
setForward ( $shouldForward) | |
Sets if site.tld/path/key:pageTitle should forward users to the page on the actual site, where "key" is the local identifier. More... | |
setGlobalId ( $globalId) | |
Sets the global site identifier (ie enwiktionary). More... | |
setGroup ( $group) | |
Sets the group of the site (ie wikipedia). More... | |
setInternalId ( $internalId=null) | |
Sets the internal identifier for the site. More... | |
setLanguageCode ( $languageCode) | |
Sets language code of the sites primary language. More... | |
setLinkPath ( $fullUrl) | |
Sets the path used to construct links with. More... | |
setPath ( $pathType, $fullUrl) | |
Sets the path used to construct links with. More... | |
setSource ( $source) | |
Sets the source of the site data (ie 'local', 'wikidata', 'my-magical-repo'). More... | |
shouldForward () | |
Gets if site.tld/path/key:pageTitle should forward users to the page on the actual site, where "key" is the local identifier. More... | |
unserialize ( $serialized) | |
Static Public Member Functions | |
static | newForType ( $siteType) |
Public Attributes | |
const | GROUP_NONE = 'none' |
const | ID_EQUIVALENT = 'equivalent' |
const | ID_INTERWIKI = 'interwiki' |
const | PATH_LINK = 'link' |
const | SOURCE_LOCAL = 'local' |
const | TYPE_MEDIAWIKI = 'mediawiki' |
const | TYPE_UNKNOWN = 'unknown' |
Protected Attributes | |
array | $extraConfig = [] |
array | $extraData = [] |
bool | $forward = false |
string null | $globalId = null |
string | $group = self::GROUP_NONE |
int null | $internalId = null |
string null | $languageCode = null |
array[] | $localIds = [] |
Holds the local ids for this site. More... | |
string | $source = self::SOURCE_LOCAL |
string | $type = self::TYPE_UNKNOWN |
Site::__construct | ( | $type = self::TYPE_UNKNOWN | ) |
string | $type |
Reimplemented in MediaWikiSite.
Definition at line 129 of file Site.php.
Referenced by unserialize().
Site::addInterwikiId | ( | $identifier | ) |
Adds an interwiki id to the site.
string | $identifier |
Definition at line 522 of file Site.php.
References addLocalId().
Referenced by SiteTest\testAddInterwikiId().
Site::addLocalId | ( | $type, | |
$identifier | |||
) |
Adds a local identifier.
string | $type | |
string | $identifier |
Definition at line 501 of file Site.php.
References $type.
Referenced by addInterwikiId(), and addNavigationId().
Site::addNavigationId | ( | $identifier | ) |
Adds a navigation id to the site.
string | $identifier |
Definition at line 533 of file Site.php.
References addLocalId().
Referenced by SiteTest\testAddNavigationId().
Site::getAllPaths | ( | ) |
Returns the paths as associative array.
The keys are path types, the values are the path urls.
Definition at line 620 of file Site.php.
Referenced by SiteExporter\exportSite(), getPath(), SiteTest\testGetAllPaths(), and SiteTest\testSetAndRemovePath().
Site::getDomain | ( | ) |
Returns the domain of the site, ie en.wikipedia.org Or false if it's not known.
Definition at line 266 of file Site.php.
References $path, and getLinkPath().
Site::getExtraConfig | ( | ) |
Returns the type specific config.
Definition at line 429 of file Site.php.
References $extraConfig.
Site::getExtraData | ( | ) |
Returns the type specific fields.
Definition at line 407 of file Site.php.
References $extraData.
Site::getGlobalId | ( | ) |
Returns the global site identifier (ie enwiktionary).
Definition at line 140 of file Site.php.
References $globalId.
Referenced by SiteExporter\exportSite(), MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis(), HashSiteStore\saveSite(), SiteTest\testGetGlobalId(), and SiteTest\testSetGlobalId().
Site::getGroup | ( | ) |
Gets the group of the site (ie wikipedia).
Definition at line 179 of file Site.php.
References $group.
Referenced by SiteExporter\exportSite().
Site::getInternalId | ( | ) |
Returns the set internal identifier for the site.
Definition at line 477 of file Site.php.
References $internalId.
Site::getInterwikiIds | ( | ) |
Returns the interwiki link identifiers that can be used for this site.
Definition at line 544 of file Site.php.
References ID_INTERWIKI.
Referenced by MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis(), SiteTest\testAddInterwikiId(), and SiteTest\testGetInterwikiIds().
Site::getLanguageCode | ( | ) |
Returns language code of the sites primary language.
Or null if it's not known.
Definition at line 452 of file Site.php.
References $languageCode.
Referenced by SiteTest\testGetLanguageCode(), and SiteTest\testSetLanguageCode().
Site::getLinkPath | ( | ) |
Returns the path used to construct links with or false if there is no such path.
Shall be equivalent to getPath( getLinkPathType() ).
Definition at line 334 of file Site.php.
References $type, getLinkPathType(), and getPath().
Referenced by getDomain(), MediaWikiSite\getPageUrl(), getPageUrl(), and getProtocol().
Site::getLinkPathType | ( | ) |
Returns the main path type, that is the type of the path that should generally be used to construct links to the target site.
This default implementation returns Site::PATH_LINK as the default path type. Subclasses can override this to define a different default path type, or return false to disable site links.
Reimplemented in MediaWikiSite.
Definition at line 351 of file Site.php.
References PATH_LINK.
Referenced by getLinkPath(), and setLinkPath().
Site::getLocalIds | ( | ) |
Returns all local ids.
Definition at line 571 of file Site.php.
References $localIds.
Referenced by SitesCacheFileBuilder\buildLocalIdentifiers(), and SiteExporter\exportSite().
Site::getNavigationIds | ( | ) |
Returns the equivalent link identifiers that can be used to make the site show up in interfaces such as the "language links" section.
Definition at line 558 of file Site.php.
References ID_EQUIVALENT.
Referenced by SiteTest\testAddNavigationId(), and SiteTest\testGetNavigationIds().
Site::getPageUrl | ( | $pageName = false | ) |
Returns the full URL for the given page on the site.
Or false if the needed information is not known.
This generated URL is usually based upon the path returned by getLinkPath(), but this is not a requirement.
This implementation returns a URL constructed using the path returned by getLinkPath().
bool | string | $pageName |
Reimplemented in MediaWikiSite.
Definition at line 370 of file Site.php.
References getLinkPath().
Referenced by MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis().
Site::getPath | ( | $pathType | ) |
Returns the path of the provided type or false if there is no such path.
string | $pathType |
Definition at line 607 of file Site.php.
References getAllPaths().
Referenced by MediaWikiSite\getFileUrl(), getLinkPath(), MediaWikiSite\getRelativeFilePath(), MediaWikiSite\getRelativePagePath(), SiteTest\testGetPath(), and SiteTest\testSetAndRemovePath().
Site::getProtocol | ( | ) |
Returns the protocol of the site.
MWException |
Definition at line 284 of file Site.php.
References $path, and getLinkPath().
Site::getSource | ( | ) |
Returns the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').
Definition at line 207 of file Site.php.
References $source.
Referenced by SiteExporter\exportSite(), and MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis().
Site::getType | ( | ) |
Returns the type of the site (ie mediawiki).
Definition at line 168 of file Site.php.
References $type.
Referenced by SiteExporter\exportSite(), and SiteTest\testGetType().
|
static |
string | $siteType |
Definition at line 644 of file Site.php.
References $wgSiteTypes, and global.
Referenced by DBSiteStore\loadSites(), SiteImporter\makeSite(), FileBasedSiteLookup\newSiteFromArray(), SiteImporterTest\provideImportFromXML(), SiteExporterTest\provideRoundTrip(), SiteExporterTest\testExportSites(), and SiteImporterTest\testImportFromFile().
Site::normalizePageName | ( | $pageName | ) |
Returns $pageName without changes.
Subclasses may override this to apply some kind of normalization.
string | $pageName |
Reimplemented in MediaWikiSite.
Definition at line 396 of file Site.php.
Referenced by SiteTest\testNormalizePageName().
Site::removePath | ( | $pathType | ) |
Removes the path of the provided type if it's set.
string | $pathType |
Definition at line 631 of file Site.php.
Referenced by SiteTest\testSetAndRemovePath().
Site::serialize | ( | ) |
Definition at line 661 of file Site.php.
References $extraConfig, $extraData, $forward, $globalId, $group, $internalId, $languageCode, $localIds, $source, and $type.
Referenced by SitesCacheFileBuilder\getSiteAsArray().
Site::setExtraConfig | ( | array | $extraConfig | ) |
Sets the type specific config.
array | $extraConfig |
Definition at line 440 of file Site.php.
References $extraConfig.
Referenced by unserialize().
Site::setExtraData | ( | array | $extraData | ) |
Sets the type specific fields.
array | $extraData |
Definition at line 418 of file Site.php.
References $extraData.
Referenced by unserialize().
Site::setForward | ( | $shouldForward | ) |
Sets if site.tld/path/key:pageTitle should forward users to the page on the actual site, where "key" is the local identifier.
bool | $shouldForward |
MWException |
Definition at line 250 of file Site.php.
Referenced by unserialize().
Site::setGlobalId | ( | $globalId | ) |
Sets the global site identifier (ie enwiktionary).
string | null | $globalId |
MWException |
Definition at line 153 of file Site.php.
References $globalId.
Referenced by SiteTest\testSetGlobalId(), and unserialize().
Site::setGroup | ( | $group | ) |
Sets the group of the site (ie wikipedia).
string | $group |
MWException |
Definition at line 192 of file Site.php.
Referenced by unserialize().
Site::setInternalId | ( | $internalId = null | ) |
Sets the internal identifier for the site.
This typically is a primary key in a db table.
int | null | $internalId |
Definition at line 489 of file Site.php.
References $internalId.
Referenced by unserialize().
Site::setLanguageCode | ( | $languageCode | ) |
Sets language code of the sites primary language.
string | $languageCode |
Definition at line 463 of file Site.php.
References $languageCode, and Language\isValidCode().
Referenced by SiteTest\testSetLanguageCode(), and unserialize().
Site::setLinkPath | ( | $fullUrl | ) |
Sets the path used to construct links with.
Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).
string | $fullUrl |
MWException |
Definition at line 317 of file Site.php.
References $type, getLinkPathType(), and setPath().
Site::setPath | ( | $pathType, | |
$fullUrl | |||
) |
Sets the path used to construct links with.
Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).
string | $pathType | |
string | $fullUrl |
MWException |
Definition at line 586 of file Site.php.
Referenced by MediaWikiSite\setFilePath(), setLinkPath(), MediaWikiSite\setPagePath(), and SiteTest\testSetAndRemovePath().
Site::setSource | ( | $source | ) |
Sets the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').
string | $source |
MWException |
Definition at line 220 of file Site.php.
References $source, and source.
Referenced by unserialize().
Site::shouldForward | ( | ) |
Gets if site.tld/path/key:pageTitle should forward users to the page on the actual site, where "key" is the local identifier.
Definition at line 236 of file Site.php.
References $forward.
Referenced by SiteExporter\exportSite().
Site::unserialize | ( | $serialized | ) |
string | $serialized |
Definition at line 686 of file Site.php.
References $serialized, __construct(), setExtraConfig(), setExtraData(), setForward(), setGlobalId(), setGroup(), setInternalId(), setLanguageCode(), and setSource().
|
protected |
Definition at line 108 of file Site.php.
Referenced by getExtraConfig(), serialize(), and setExtraConfig().
|
protected |
Definition at line 101 of file Site.php.
Referenced by getExtraData(), serialize(), and setExtraData().
|
protected |
|
protected |
Definition at line 56 of file Site.php.
Referenced by getGlobalId(), serialize(), and setGlobalId().
|
protected |
Definition at line 70 of file Site.php.
Referenced by getGroup(), serialize(), and setGroup().
|
protected |
Definition at line 122 of file Site.php.
Referenced by getInternalId(), serialize(), and setInternalId().
|
protected |
Definition at line 84 of file Site.php.
Referenced by getLanguageCode(), serialize(), and setLanguageCode().
|
protected |
Holds the local ids for this site.
local id type => [ ids for this type (strings) ]
Definition at line 94 of file Site.php.
Referenced by getLocalIds(), and serialize().
|
protected |
Definition at line 77 of file Site.php.
Referenced by getSource(), serialize(), and setSource().
|
protected |
Definition at line 63 of file Site.php.
Referenced by MediaWikiSite\__construct(), __construct(), addLocalId(), getLinkPath(), getType(), serialize(), and setLinkPath().
const Site::GROUP_NONE = 'none' |
Definition at line 33 of file Site.php.
Referenced by SiteExporter\exportSite(), and SiteImporter\makeSite().
const Site::ID_EQUIVALENT = 'equivalent' |
Definition at line 36 of file Site.php.
Referenced by getNavigationIds(), SiteImporterTest\provideImportFromXML(), SiteExporterTest\provideRoundTrip(), and SiteImporterTest\testImportFromFile().
const Site::ID_INTERWIKI = 'interwiki' |
Definition at line 35 of file Site.php.
Referenced by getInterwikiIds(), SiteImporterTest\provideImportFromXML(), SiteExporterTest\provideRoundTrip(), SiteExporterTest\testExportSites(), and SiteImporterTest\testImportFromFile().
const Site::PATH_LINK = 'link' |
Definition at line 40 of file Site.php.
Referenced by getLinkPathType(), SiteImporterTest\provideImportFromXML(), SiteExporterTest\provideRoundTrip(), SiteExporterTest\testExportSites(), and SiteImporterTest\testImportFromFile().
const Site::SOURCE_LOCAL = 'local' |
Definition at line 38 of file Site.php.
Referenced by SiteExporter\exportSite(), and SiteImporter\makeSite().
const Site::TYPE_MEDIAWIKI = 'mediawiki' |
Definition at line 31 of file Site.php.
Referenced by SiteImporterTest\provideImportFromXML(), SiteExporterTest\provideRoundTrip(), and SiteImporterTest\testImportFromFile().
const Site::TYPE_UNKNOWN = 'unknown' |
Definition at line 30 of file Site.php.
Referenced by SiteExporter\exportSite(), SiteImporter\makeSite(), FileBasedSiteLookup\newSiteFromArray(), SiteImporterTest\provideImportFromXML(), SiteExporterTest\provideRoundTrip(), SiteExporterTest\testExportSites(), and SiteImporterTest\testImportFromFile().