SiteObject Class Reference
Inheritance diagram for SiteObject:
Collaboration diagram for SiteObject:
Additional Inherited Members | |
 Public Member Functions inherited from Site | |
| __construct ( $type=self::TYPE_UNKNOWN) | |
| Constructor. More... | |
| 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 type 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 type 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 inherited from Site | |
| static | newForType ( $siteType) |
| Public Attributes inherited from Site | |
| const | GROUP_NONE = 'none' |
| const | ID_EQUIVALENT = 'equivalent' |
| const | ID_INTERWIKI = 'interwiki' |
| const | PATH_LINK = 'link' |
| const | SERIAL_VERSION_ID = '2013-01-23' |
| const | SOURCE_LOCAL = 'local' |
| const | TYPE_MEDIAWIKI = 'mediawiki' |
| const | TYPE_UNKNOWN = 'unknown' |
| Protected Attributes inherited from Site | |
| array | $extraConfig = array() |
| array | $extraData = array() |
| bool | $forward = false |
| string null | $globalId = null |
| string | $group = self::GROUP_NONE |
| int null | $internalId = null |
| string null | $languageCode = null |
| array[] | $localIds = array() |
| Holds the local ids for this site. More... | |
| string | $source = self::SOURCE_LOCAL |
| string | $type = self::TYPE_UNKNOWN |
Detailed Description
The documentation for this class was generated from the following file:
- includes/site/Site.php
