MediaWiki REL1_41
|
Represents a single site. More...
Inherited by MediaWikiSite.
Public Member Functions | |
__construct ( $type=self::TYPE_UNKNOWN) | |
__serialize () | |
__unserialize ( $fields) | |
addInterwikiId ( $identifier) | |
Adds an interwiki id to the site. | |
addLocalId ( $type, $identifier) | |
Adds a local identifier. | |
addNavigationId ( $identifier) | |
Adds a navigation id to the site. | |
getAllPaths () | |
Returns the paths as associative array. | |
getDomain () | |
Returns the domain of the site, ie en.wikipedia.org Or null if it's not known. | |
getExtraConfig () | |
Returns the type specific config. | |
getExtraData () | |
Returns the type specific fields. | |
getGlobalId () | |
Returns the global site identifier (ie enwiktionary). | |
getGroup () | |
Gets the group of the site (ie wikipedia). | |
getInternalId () | |
Returns the set internal identifier for the site. | |
getInterwikiIds () | |
Returns the interwiki link identifiers that can be used for this site. | |
getLanguageCode () | |
Returns language code of the sites primary language. | |
getLinkPath () | |
Returns the path used to construct links with or false if there is no such path. | |
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. | |
getLocalIds () | |
Returns all local ids. | |
getNavigationIds () | |
Returns the equivalent link identifiers that can be used to make the site show up in interfaces such as the "language links" section. | |
getPageUrl ( $pageName=false) | |
Get the full URL for the given page on the site. | |
getPath ( $pathType) | |
Returns the path of the provided type or null if there is no such path. | |
getProtocol () | |
Returns the protocol of the site. | |
getSource () | |
Returns the source of the site data (ie 'local', 'wikidata', 'my-magical-repo'). | |
getType () | |
Returns the type of the site (ie mediawiki). | |
normalizePageName ( $pageName, $followRedirect=MediaWikiPageNameNormalizer::FOLLOW_REDIRECT) | |
Attempt to normalize the page name in some fashion. | |
removePath ( $pathType) | |
Removes the path of the provided type if it's set. | |
setExtraConfig (array $extraConfig) | |
Sets the type specific config. | |
setExtraData (array $extraData) | |
Sets the type specific fields. | |
setForward (bool $shouldForward) | |
Sets if site.tld/path/key:pageTitle should forward users to the page on the actual site, where "key" is the local identifier. | |
setGlobalId (?string $globalId) | |
Sets the global site identifier (ie enwiktionary). | |
setGroup (string $group) | |
Sets the group of the site (ie wikipedia). | |
setInternalId ( $internalId=null) | |
Sets the internal identifier for the site. | |
setLanguageCode ( $languageCode) | |
Sets language code of the sites primary language. | |
setLinkPath ( $fullUrl) | |
Set the path used to construct links with. | |
setPath ( $pathType, string $fullUrl) | |
Set the path used to construct links with. | |
setSource (string $source) | |
Sets the source of the site data (ie 'local', 'wikidata', 'my-magical-repo'). | |
shouldForward () | |
Gets if site.tld/path/key:pageTitle should forward users to the page on the actual site, where "key" is the local identifier. | |
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 |
string[][] false | $localIds = [] |
Holds the local ids for this site. | |
string | $source = self::SOURCE_LOCAL |
string | $type = self::TYPE_UNKNOWN |
Site::__construct | ( | $type = self::TYPE_UNKNOWN | ) |
string | $type |
Reimplemented in MediaWikiSite.
Definition at line 132 of file Site.php.
References $type.
Site::__serialize | ( | ) |
Site::__unserialize | ( | $fields | ) |
Site::addInterwikiId | ( | $identifier | ) |
Site::addLocalId | ( | $type, | |
$identifier ) |
Site::addNavigationId | ( | $identifier | ) |
Site::getAllPaths | ( | ) |
Site::getDomain | ( | ) |
Site::getExtraConfig | ( | ) |
Site::getExtraData | ( | ) |
Site::getGlobalId | ( | ) |
Returns the global site identifier (ie enwiktionary).
Definition at line 143 of file Site.php.
References $globalId.
Referenced by HashSiteStore\saveSite().
Site::getGroup | ( | ) |
Site::getInternalId | ( | ) |
Site::getInterwikiIds | ( | ) |
Site::getLanguageCode | ( | ) |
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 311 of file Site.php.
Referenced by MediaWikiSite\getPageUrl().
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.
Site::getLocalIds | ( | ) |
Site::getNavigationIds | ( | ) |
Site::getPageUrl | ( | $pageName = false | ) |
Get the full URL for the given page on the site.
Returns null 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().
string | false | $pageName |
Reimplemented in MediaWikiSite.
Site::getPath | ( | $pathType | ) |
Returns the path of the provided type or null if there is no such path.
string | $pathType |
Definition at line 586 of file Site.php.
Referenced by MediaWikiSite\getFileUrl(), MediaWikiSite\getRelativeFilePath(), and MediaWikiSite\getRelativePagePath().
Site::getProtocol | ( | ) |
Site::getSource | ( | ) |
Site::getType | ( | ) |
|
static |
string | $siteType |
Definition at line 623 of file Site.php.
Referenced by DBSiteStore\loadSites(), and SiteImporter\makeSite().
Site::normalizePageName | ( | $pageName, | |
$followRedirect = MediaWikiPageNameNormalizer::FOLLOW_REDIRECT ) |
Attempt to normalize the page name in some fashion.
May return false to indicate various kinds of failure.
This implementation returns $pageName without changes.
string | $pageName | |
int | $followRedirect | either MediaWikiPageNameNormalizer::FOLLOW_REDIRECT or MediaWikiPageNameNormalizer::NOFOLLOW_REDIRECT |
Reimplemented in MediaWikiSite.
Site::removePath | ( | $pathType | ) |
Site::setExtraConfig | ( | array | $extraConfig | ) |
Site::setExtraData | ( | array | $extraData | ) |
Site::setForward | ( | bool | $shouldForward | ) |
Site::setGlobalId | ( | ?string | $globalId | ) |
Site::setGroup | ( | string | $group | ) |
Site::setInternalId | ( | $internalId = null | ) |
Site::setLanguageCode | ( | $languageCode | ) |
Site::setLinkPath | ( | $fullUrl | ) |
Set the path used to construct links with.
Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).
string | $fullUrl |
Site::setPath | ( | $pathType, | |
string | $fullUrl ) |
Set the path used to construct links with.
Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).
string | $pathType | |
string | $fullUrl |
Definition at line 569 of file Site.php.
Referenced by MediaWikiSite\setFilePath(), and MediaWikiSite\setPagePath().
Site::setSource | ( | string | $source | ) |
Site::shouldForward | ( | ) |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 66 of file Site.php.
Referenced by MediaWikiSite\__construct(), __construct(), and getType().
const Site::GROUP_NONE = 'none' |
Definition at line 36 of file Site.php.
Referenced by SiteImporter\makeSite().
const Site::SOURCE_LOCAL = 'local' |
Definition at line 41 of file Site.php.
Referenced by SiteImporter\makeSite().
const Site::TYPE_UNKNOWN = 'unknown' |
Definition at line 33 of file Site.php.
Referenced by SiteImporter\makeSite().