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

Public Member Functions

 __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

static newForType ( $siteType)
 

Public Attributes

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

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

Definition at line 29 of file Site.php.

Constructor & Destructor Documentation

◆ __construct()

Site::__construct (   $type = self::TYPE_UNKNOWN)

Constructor.

Since
1.21
Parameters
string$type

Reimplemented in MediaWikiSite.

Definition at line 122 of file Site.php.

References $type, and type.

Referenced by unserialize().

Member Function Documentation

◆ addInterwikiId()

Site::addInterwikiId (   $identifier)

Adds an interwiki id to the site.

Since
1.21
Parameters
string$identifier

Definition at line 511 of file Site.php.

References addLocalId().

Referenced by SiteTest\testAddInterwikiId().

◆ addLocalId()

Site::addLocalId (   $type,
  $identifier 
)

Adds a local identifier.

Since
1.21
Parameters
string$type
string$identifier

Definition at line 490 of file Site.php.

References $type, and array().

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 522 of file Site.php.

References addLocalId().

Referenced by SiteTest\testAddNavigationId().

◆ 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 605 of file Site.php.

References array().

Referenced by getPath(), SiteTest\testGetAllPaths(), and SiteTest\testSetAndRemovePath().

◆ 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 259 of file Site.php.

References $path, and getLinkPath().

Referenced by SiteSQLStore\getRowFromSite().

◆ getExtraConfig()

Site::getExtraConfig ( )

Returns the type specific config.

Since
1.21
Returns
array

Definition at line 421 of file Site.php.

References $extraConfig.

Referenced by SiteSQLStore\getRowFromSite().

◆ getExtraData()

Site::getExtraData ( )

Returns the type specific fields.

Since
1.21
Returns
array

Definition at line 399 of file Site.php.

References $extraData.

Referenced by SiteSQLStore\getRowFromSite().

◆ getGlobalId()

Site::getGlobalId ( )

Returns the global site identifier (ie enwiktionary).

Since
1.21
Returns
string|null

Definition at line 133 of file Site.php.

References $globalId.

Referenced by SiteSQLStore\getRowFromSite(), SiteTest\testGetGlobalId(), and SiteTest\testSetGlobalId().

◆ getGroup()

Site::getGroup ( )

Gets the type of the site (ie wikipedia).

Since
1.21
Returns
string

Definition at line 172 of file Site.php.

References $group.

Referenced by SiteSQLStore\getRowFromSite().

◆ getInternalId()

Site::getInternalId ( )

Returns the set internal identifier for the site.

Since
1.21
Returns
string|null

Definition at line 466 of file Site.php.

References $internalId.

Referenced by SiteSQLStore\getRowFromSite().

◆ getInterwikiIds()

Site::getInterwikiIds ( )

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

Since
1.21
Returns
string[]

Definition at line 533 of file Site.php.

References array(), and ID_INTERWIKI.

Referenced by SiteTest\testAddInterwikiId(), and SiteTest\testGetInterwikiIds().

◆ 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 444 of file Site.php.

References $languageCode.

Referenced by SiteSQLStore\getRowFromSite(), SiteTest\testGetLanguageCode(), and SiteTest\testSetLanguageCode().

◆ 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 327 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 343 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 556 of file Site.php.

References $localIds.

◆ 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 545 of file Site.php.

References array(), and ID_EQUIVALENT.

Referenced by SiteTest\testAddNavigationId(), and SiteTest\testGetNavigationIds().

◆ getPageUrl()

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

Since
1.21
Parameters
bool | String$pageName
Returns
string|boolean false

Reimplemented in MediaWikiSite.

Definition at line 362 of file Site.php.

References getLinkPath().

◆ 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 592 of file Site.php.

References getAllPaths().

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

◆ getProtocol()

Site::getProtocol ( )

Returns the protocol of the site.

Since
1.21
Exceptions
MWException
Returns
string

Definition at line 277 of file Site.php.

References $path, and getLinkPath().

Referenced by SiteSQLStore\getRowFromSite().

◆ getSource()

Site::getSource ( )

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

Since
1.21
Returns
string

Definition at line 200 of file Site.php.

References $source.

Referenced by SiteSQLStore\getRowFromSite().

◆ getType()

Site::getType ( )

Returns the type of the site (ie mediawiki).

Since
1.21
Returns
string

Definition at line 161 of file Site.php.

References $type.

Referenced by SiteSQLStore\getRowFromSite(), and SiteTest\testGetType().

◆ newForType()

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

Definition at line 629 of file Site.php.

References global.

Referenced by SiteSQLStore\siteFromRow().

◆ normalizePageName()

Site::normalizePageName (   $pageName)

Returns $pageName without changes.

Subclasses may override this to apply some kind of normalization.

See also
Site::normalizePageName
Since
1.21
Parameters
string$pageName
Returns
string

Reimplemented in MediaWikiSite.

Definition at line 388 of file Site.php.

Referenced by SiteTest\testNormalizePageName().

◆ removePath()

Site::removePath (   $pathType)

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

Since
1.21
Parameters
string$pathType

Definition at line 616 of file Site.php.

Referenced by SiteTest\testSetAndRemovePath().

◆ serialize()

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

Definition at line 646 of file Site.php.

References array(), source, and type.

◆ setExtraConfig()

Site::setExtraConfig ( array  $extraConfig)

Sets the type specific config.

Since
1.21
Parameters
array$extraConfig

Definition at line 432 of file Site.php.

References $extraConfig.

Referenced by unserialize().

◆ setExtraData()

Site::setExtraData ( array  $extraData)

Sets the type specific fields.

Since
1.21
Parameters
array$extraData

Definition at line 410 of file Site.php.

References $extraData.

Referenced by unserialize().

◆ 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
boolean$shouldForward
Exceptions
MWException

Definition at line 243 of file Site.php.

Referenced by unserialize().

◆ setGlobalId()

Site::setGlobalId (   $globalId)

Sets the global site identifier (ie enwiktionary).

Since
1.21
Parameters
string | null$globalId
Exceptions
MWException

Definition at line 146 of file Site.php.

References $globalId.

Referenced by SiteTest\testSetGlobalId(), and unserialize().

◆ setGroup()

Site::setGroup (   $group)

Sets the type of the site (ie wikipedia).

Since
1.21
Parameters
string$group
Exceptions
MWException

Definition at line 185 of file Site.php.

References $group.

Referenced by unserialize().

◆ 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 478 of file Site.php.

References $internalId.

Referenced by unserialize().

◆ setLanguageCode()

Site::setLanguageCode (   $languageCode)

Sets language code of the sites primary language.

Since
1.21
Parameters
string$languageCode

Definition at line 455 of file Site.php.

References $languageCode.

Referenced by SiteTest\testSetLanguageCode(), and unserialize().

◆ 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 310 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 571 of file Site.php.

References array().

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

◆ 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 213 of file Site.php.

References $source, and source.

Referenced by unserialize().

◆ 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
boolean

Definition at line 229 of file Site.php.

References $forward.

Referenced by SiteSQLStore\getRowFromSite().

◆ unserialize()

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

Definition at line 671 of file Site.php.

References $serialized, __construct(), setExtraConfig(), setExtraData(), setForward(), setGlobalId(), setGroup(), setInternalId(), setLanguageCode(), and setSource().

Member Data Documentation

◆ $extraConfig

array Site::$extraConfig = array()
protected
Since
1.21

Definition at line 101 of file Site.php.

Referenced by getExtraConfig(), and setExtraConfig().

◆ $extraData

array Site::$extraData = array()
protected
Since
1.21

Definition at line 95 of file Site.php.

Referenced by getExtraData(), and setExtraData().

◆ $forward

bool Site::$forward = false
protected
Since
1.21

Definition at line 107 of file Site.php.

Referenced by shouldForward().

◆ $globalId

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

Definition at line 56 of file Site.php.

Referenced by getGlobalId(), MediaWikiSite\newFromGlobalId(), and setGlobalId().

◆ $group

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

Definition at line 68 of file Site.php.

Referenced by getGroup(), and setGroup().

◆ $internalId

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

Definition at line 113 of file Site.php.

Referenced by getInternalId(), and setInternalId().

◆ $languageCode

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

Definition at line 80 of file Site.php.

Referenced by getLanguageCode(), and setLanguageCode().

◆ $localIds

array [] Site::$localIds = array()
protected

Holds the local ids for this site.

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

Since
1.21

Definition at line 89 of file Site.php.

Referenced by getLocalIds().

◆ $source

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

Definition at line 74 of file Site.php.

Referenced by getSource(), and setSource().

◆ $type

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

Definition at line 62 of file Site.php.

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

◆ GROUP_NONE

const Site::GROUP_NONE = 'none'

Definition at line 34 of file Site.php.

Referenced by SiteSQLStore\newSitesTable().

◆ ID_EQUIVALENT

const Site::ID_EQUIVALENT = 'equivalent'

Definition at line 37 of file Site.php.

Referenced by getNavigationIds().

◆ ID_INTERWIKI

const Site::ID_INTERWIKI = 'interwiki'

Definition at line 36 of file Site.php.

Referenced by getInterwikiIds().

◆ PATH_LINK

const Site::PATH_LINK = 'link'

Definition at line 41 of file Site.php.

Referenced by getLinkPathType().

◆ SERIAL_VERSION_ID

const Site::SERIAL_VERSION_ID = '2013-01-23'

Definition at line 50 of file Site.php.

Referenced by SiteList\getSerialVersionId().

◆ SOURCE_LOCAL

const Site::SOURCE_LOCAL = 'local'

Definition at line 39 of file Site.php.

Referenced by SiteSQLStore\newSitesTable().

◆ TYPE_MEDIAWIKI

const Site::TYPE_MEDIAWIKI = 'mediawiki'

Definition at line 32 of file Site.php.

◆ TYPE_UNKNOWN

const Site::TYPE_UNKNOWN = 'unknown'

Definition at line 31 of file Site.php.

Referenced by SiteSQLStore\newSitesTable(), and SiteSQLStore\siteFromRow().


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