MediaWiki  master
Site Class Reference
Inheritance diagram for Site:
Collaboration diagram for Site:

Public Member Functions

 __construct ( $type=self::TYPE_UNKNOWN)
 
 __serialize ()
 
 __unserialize ( $fields)
 
 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, $followRedirect=MediaWikiPageNameNormalizer::FOLLOW_REDIRECT)
 Attempt to normalize the page name in some fashion. 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
 
string[][] false $localIds = []
 Holds the local ids for this site. More...
 
string $source = self::SOURCE_LOCAL
 
string $type = self::TYPE_UNKNOWN
 

Detailed Description

Definition at line 33 of file Site.php.

Constructor & Destructor Documentation

◆ __construct()

Site::__construct (   $type = self::TYPE_UNKNOWN)
Since
1.21
Parameters
string$type

Reimplemented in MediaWikiSite.

Definition at line 133 of file Site.php.

References $type.

Member Function Documentation

◆ __serialize()

Site::__serialize ( )
See also
Serializable::serialize
Since
1.38
Returns
array

Definition at line 686 of file Site.php.

References $source, and $type.

◆ __unserialize()

Site::__unserialize (   $fields)
See also
Serializable::unserialize
Since
1.38
Parameters
array$fields

Definition at line 719 of file Site.php.

◆ addInterwikiId()

Site::addInterwikiId (   $identifier)

Adds an interwiki id to the site.

Since
1.21
Parameters
string$identifier

Definition at line 535 of file Site.php.

References addLocalId().

◆ addLocalId()

Site::addLocalId (   $type,
  $identifier 
)

Adds a local identifier.

Since
1.21
Parameters
string$type
string$identifier

Definition at line 514 of file Site.php.

References $type.

Referenced by addInterwikiId(), and addNavigationId().

◆ addNavigationId()

Site::addNavigationId (   $identifier)

Adds a navigation id to the site.

Since
1.21
Parameters
string$identifier

Definition at line 546 of file Site.php.

References addLocalId().

◆ getAllPaths()

Site::getAllPaths ( )

Returns the paths as associative array.

The keys are path types, the values are the path urls.

Since
1.21
Returns
string[]

Definition at line 633 of file Site.php.

Referenced by SiteExporter\exportSite(), and getPath().

◆ getDomain()

Site::getDomain ( )

Returns the domain of the site, ie en.wikipedia.org Or false if it's not known.

Since
1.21
Returns
string|null

Definition at line 270 of file Site.php.

References $path, and getLinkPath().

◆ getExtraConfig()

Site::getExtraConfig ( )

Returns the type specific config.

Since
1.21
Returns
array

Definition at line 438 of file Site.php.

References $extraConfig.

◆ getExtraData()

Site::getExtraData ( )

Returns the type specific fields.

Since
1.21
Returns
array

Definition at line 416 of file Site.php.

References $extraData.

◆ getGlobalId()

Site::getGlobalId ( )

Returns the global site identifier (ie enwiktionary).

Since
1.21
Returns
string|null

Definition at line 144 of file Site.php.

References $globalId.

Referenced by SiteExporter\exportSite(), MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis(), and HashSiteStore\saveSite().

◆ getGroup()

Site::getGroup ( )

Gets the group of the site (ie wikipedia).

Since
1.21
Returns
string

Definition at line 183 of file Site.php.

References $group.

Referenced by SiteExporter\exportSite().

◆ getInternalId()

Site::getInternalId ( )

Returns the set internal identifier for the site.

Since
1.21
Returns
int|null

Definition at line 490 of file Site.php.

References $internalId.

◆ getInterwikiIds()

Site::getInterwikiIds ( )

Returns the interwiki link identifiers that can be used for this site.

Since
1.21
Returns
string[]

Definition at line 557 of file Site.php.

References ID_INTERWIKI.

Referenced by MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis().

◆ getLanguageCode()

Site::getLanguageCode ( )

Returns language code of the sites primary language.

Or null if it's not known.

Since
1.21
Returns
string|null

Definition at line 461 of file Site.php.

References $languageCode.

◆ getLinkPath()

Site::getLinkPath ( )

Returns the path used to construct links with or false if there is no such path.

Shall be equivalent to getPath( getLinkPathType() ).

Returns
string|null

Definition at line 338 of file Site.php.

References $type, getLinkPathType(), and getPath().

Referenced by getDomain(), MediaWikiSite\getPageUrl(), getPageUrl(), and getProtocol().

◆ getLinkPathType()

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.

Since
1.21
Returns
string|null

Reimplemented in MediaWikiSite.

Definition at line 355 of file Site.php.

References PATH_LINK.

Referenced by getLinkPath(), and setLinkPath().

◆ getLocalIds()

Site::getLocalIds ( )

Returns all local ids.

Since
1.21
Returns
array[]

Definition at line 584 of file Site.php.

References $localIds.

Referenced by SiteExporter\exportSite().

◆ getNavigationIds()

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.

Since
1.21
Returns
string[]

Definition at line 571 of file Site.php.

References ID_EQUIVALENT.

◆ getPageUrl()

Site::getPageUrl (   $pageName = false)

Returns the full URL for the given page on the site.

Or 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().

Since
1.21
Parameters
bool | string$pageName
Returns
string|null

Reimplemented in MediaWikiSite.

Definition at line 374 of file Site.php.

References getLinkPath().

Referenced by MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis().

◆ getPath()

Site::getPath (   $pathType)

Returns the path of the provided type or false if there is no such path.

Since
1.21
Parameters
string$pathType
Returns
string|null

Definition at line 620 of file Site.php.

References getAllPaths().

Referenced by MediaWikiSite\getFileUrl(), getLinkPath(), MediaWikiSite\getRelativeFilePath(), and MediaWikiSite\getRelativePagePath().

◆ getProtocol()

Site::getProtocol ( )

Returns the protocol of the site.

Since
1.21
Exceptions
MWException
Returns
string

Definition at line 288 of file Site.php.

References $path, and getLinkPath().

◆ getSource()

Site::getSource ( )

Returns the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').

Since
1.21
Returns
string

Definition at line 211 of file Site.php.

References $source.

Referenced by SiteExporter\exportSite(), and MediaWiki\Interwiki\InterwikiLookupAdapter\getSiteInterwikis().

◆ getType()

Site::getType ( )

Returns the type of the site (ie mediawiki).

Since
1.21
Returns
string

Definition at line 172 of file Site.php.

References $type.

Referenced by SiteExporter\exportSite().

◆ newForType()

static Site::newForType (   $siteType)
static
Since
1.21
Parameters
string$siteType
Returns
Site

Definition at line 657 of file Site.php.

Referenced by DBSiteStore\loadSites(), and SiteImporter\makeSite().

◆ normalizePageName()

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.

See also
Site::normalizePageName
Since
1.21
1.37 Added $followRedirect
Parameters
string$pageName
int$followRedirecteither MediaWikiPageNameNormalizer::FOLLOW_REDIRECT or MediaWikiPageNameNormalizer::NOFOLLOW_REDIRECT
Returns
string|false

Reimplemented in MediaWikiSite.

Definition at line 405 of file Site.php.

◆ removePath()

Site::removePath (   $pathType)

Removes the path of the provided type if it's set.

Since
1.21
Parameters
string$pathType

Definition at line 644 of file Site.php.

◆ serialize()

Site::serialize ( )
See also
Serializable::serialize
Since
1.21
Returns
string

Definition at line 675 of file Site.php.

◆ setExtraConfig()

Site::setExtraConfig ( array  $extraConfig)

Sets the type specific config.

Since
1.21
Parameters
array$extraConfig

Definition at line 449 of file Site.php.

References $extraConfig.

◆ setExtraData()

Site::setExtraData ( array  $extraData)

Sets the type specific fields.

Since
1.21
Parameters
array$extraData

Definition at line 427 of file Site.php.

References $extraData.

◆ setForward()

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.

Since
1.21
Parameters
bool$shouldForward
Exceptions
MWException

Definition at line 254 of file Site.php.

◆ setGlobalId()

Site::setGlobalId (   $globalId)

Sets the global site identifier (ie enwiktionary).

Since
1.21
Parameters
string | null$globalId
Exceptions
MWException

Definition at line 157 of file Site.php.

References $globalId.

◆ setGroup()

Site::setGroup (   $group)

Sets the group of the site (ie wikipedia).

Since
1.21
Parameters
string$group
Exceptions
MWException

Definition at line 196 of file Site.php.

References $group.

◆ setInternalId()

Site::setInternalId (   $internalId = null)

Sets the internal identifier for the site.

This typically is a primary key in a db table.

Since
1.21
Parameters
int | null$internalId

Definition at line 502 of file Site.php.

References $internalId.

◆ setLanguageCode()

Site::setLanguageCode (   $languageCode)

Sets language code of the sites primary language.

Since
1.21
Parameters
string | null$languageCode

Definition at line 472 of file Site.php.

References $languageCode.

◆ setLinkPath()

Site::setLinkPath (   $fullUrl)

Sets the path used to construct links with.

Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).

Parameters
string$fullUrl
Since
1.21
Exceptions
MWException

Definition at line 321 of file Site.php.

References $type, getLinkPathType(), and setPath().

◆ setPath()

Site::setPath (   $pathType,
  $fullUrl 
)

Sets the path used to construct links with.

Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).

Since
1.21
Parameters
string$pathType
string$fullUrl
Exceptions
MWException

Definition at line 599 of file Site.php.

Referenced by MediaWikiSite\setFilePath(), setLinkPath(), and MediaWikiSite\setPagePath().

◆ setSource()

Site::setSource (   $source)

Sets the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').

Since
1.21
Parameters
string$source
Exceptions
MWException

Definition at line 224 of file Site.php.

References $source.

◆ shouldForward()

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.

Since
1.21
Returns
bool

Definition at line 240 of file Site.php.

References $forward.

Referenced by SiteExporter\exportSite().

◆ unserialize()

Site::unserialize (   $serialized)
See also
Serializable::unserialize
Since
1.21
Parameters
string$serialized

Definition at line 708 of file Site.php.

Member Data Documentation

◆ $extraConfig

array Site::$extraConfig = []
protected
Since
1.21

Definition at line 112 of file Site.php.

Referenced by getExtraConfig(), and setExtraConfig().

◆ $extraData

array Site::$extraData = []
protected
Since
1.21

Definition at line 105 of file Site.php.

Referenced by getExtraData(), and setExtraData().

◆ $forward

bool Site::$forward = false
protected
Since
1.21

Definition at line 119 of file Site.php.

Referenced by shouldForward().

◆ $globalId

string null Site::$globalId = null
protected
Since
1.21

Definition at line 60 of file Site.php.

Referenced by getGlobalId(), and setGlobalId().

◆ $group

string Site::$group = self::GROUP_NONE
protected
Since
1.21

Definition at line 74 of file Site.php.

Referenced by getGroup(), and setGroup().

◆ $internalId

int null Site::$internalId = null
protected
Since
1.21

Definition at line 126 of file Site.php.

Referenced by getInternalId(), and setInternalId().

◆ $languageCode

string null Site::$languageCode = null
protected
Since
1.21

Definition at line 88 of file Site.php.

Referenced by getLanguageCode(), and setLanguageCode().

◆ $localIds

string [][] false Site::$localIds = []
protected

Holds the local ids for this site.

local id type => [ ids for this type (strings) ]

Since
1.21

Definition at line 98 of file Site.php.

Referenced by getLocalIds().

◆ $source

string Site::$source = self::SOURCE_LOCAL
protected
Since
1.21

Definition at line 81 of file Site.php.

Referenced by getSource(), and setSource().

◆ $type

string Site::$type = self::TYPE_UNKNOWN
protected
Since
1.21

Definition at line 67 of file Site.php.

Referenced by MediaWikiSite\__construct(), __construct(), addLocalId(), getLinkPath(), getType(), and setLinkPath().

◆ GROUP_NONE

const Site::GROUP_NONE = 'none'

Definition at line 37 of file Site.php.

Referenced by SiteExporter\exportSite(), and SiteImporter\makeSite().

◆ ID_EQUIVALENT

const Site::ID_EQUIVALENT = 'equivalent'

Definition at line 40 of file Site.php.

Referenced by getNavigationIds().

◆ ID_INTERWIKI

const Site::ID_INTERWIKI = 'interwiki'

Definition at line 39 of file Site.php.

Referenced by getInterwikiIds().

◆ PATH_LINK

const Site::PATH_LINK = 'link'

Definition at line 44 of file Site.php.

Referenced by getLinkPathType().

◆ SOURCE_LOCAL

const Site::SOURCE_LOCAL = 'local'

Definition at line 42 of file Site.php.

Referenced by SiteExporter\exportSite(), and SiteImporter\makeSite().

◆ TYPE_MEDIAWIKI

const Site::TYPE_MEDIAWIKI = 'mediawiki'

Definition at line 35 of file Site.php.

◆ TYPE_UNKNOWN

const Site::TYPE_UNKNOWN = 'unknown'

Definition at line 34 of file Site.php.

Referenced by SiteExporter\exportSite(), and SiteImporter\makeSite().


The documentation for this class was generated from the following file: