MediaWiki  1.28.0
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 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
 

Detailed Description

Definition at line 29 of file Site.php.

Constructor & Destructor Documentation

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

Constructor.

Since
1.21
Parameters
string$type

Definition at line 131 of file Site.php.

References $type, and type.

Referenced by unserialize().

Member Function Documentation

Site::addInterwikiId (   $identifier)

Adds an interwiki id to the site.

Since
1.21
Parameters
string$identifier

Definition at line 521 of file Site.php.

References addLocalId().

Referenced by SiteTest\testAddInterwikiId().

Site::addLocalId (   $type,
  $identifier 
)

Adds a local identifier.

Since
1.21
Parameters
string$type
string$identifier

Definition at line 500 of file Site.php.

References $type.

Referenced by addInterwikiId(), and addNavigationId().

Site::addNavigationId (   $identifier)

Adds a navigation id to the site.

Since
1.21
Parameters
string$identifier

Definition at line 532 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.

Since
1.21
Returns
string[]

Definition at line 619 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.

Since
1.21
Returns
string|null

Definition at line 268 of file Site.php.

References $path, and getLinkPath().

Site::getExtraConfig ( )

Returns the type specific config.

Since
1.21
Returns
array

Definition at line 431 of file Site.php.

References $extraConfig.

Site::getExtraData ( )

Returns the type specific fields.

Since
1.21
Returns
array

Definition at line 409 of file Site.php.

References $extraData.

Site::getGlobalId ( )

Returns the global site identifier (ie enwiktionary).

Since
1.21
Returns
string|null

Definition at line 142 of file Site.php.

References $globalId.

Referenced by SiteExporter\exportSite(), HashSiteStore\saveSite(), SiteTest\testGetGlobalId(), and SiteTest\testSetGlobalId().

Site::getGroup ( )

Gets the group of the site (ie wikipedia).

Since
1.21
Returns
string

Definition at line 181 of file Site.php.

References $group.

Referenced by SiteExporter\exportSite().

Site::getInternalId ( )

Returns the set internal identifier for the site.

Since
1.21
Returns
string|null

Definition at line 476 of file Site.php.

References $internalId.

Site::getInterwikiIds ( )

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

Since
1.21
Returns
string[]

Definition at line 543 of file Site.php.

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

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

Returns
string|null

Definition at line 336 of file Site.php.

References 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.

Since
1.21
Returns
string|null

Definition at line 353 of file Site.php.

Referenced by getLinkPath(), and setLinkPath().

Site::getLocalIds ( )

Returns all local ids.

Since
1.21
Returns
array[]

Definition at line 570 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.

Since
1.21
Returns
string[]

Definition at line 557 of file Site.php.

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

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

Definition at line 372 of file Site.php.

References getLinkPath().

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 606 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.

Since
1.21
Exceptions
MWException
Returns
string

Definition at line 286 of file Site.php.

References $path, and getLinkPath().

Site::getSource ( )

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

Since
1.21
Returns
string

Definition at line 209 of file Site.php.

References $source.

Referenced by SiteExporter\exportSite().

Site::getType ( )

Returns the type of the site (ie mediawiki).

Since
1.21
Returns
string

Definition at line 170 of file Site.php.

References $type.

Referenced by SiteExporter\exportSite(), and SiteTest\testGetType().

static Site::newForType (   $siteType)
static
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

Definition at line 398 of file Site.php.

Referenced by SiteTest\testNormalizePageName().

Site::removePath (   $pathType)

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

Since
1.21
Parameters
string$pathType

Definition at line 630 of file Site.php.

Referenced by SiteTest\testSetAndRemovePath().

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

Definition at line 660 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.

Since
1.21
Parameters
array$extraConfig

Definition at line 442 of file Site.php.

References $extraConfig.

Referenced by unserialize().

Site::setExtraData ( array  $extraData)

Sets the type specific fields.

Since
1.21
Parameters
array$extraData

Definition at line 420 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.

Since
1.21
Parameters
bool$shouldForward
Exceptions
MWException

Definition at line 252 of file Site.php.

Referenced by unserialize().

Site::setGlobalId (   $globalId)

Sets the global site identifier (ie enwiktionary).

Since
1.21
Parameters
string | null$globalId
Exceptions
MWException

Definition at line 155 of file Site.php.

References $globalId.

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

Site::setGroup (   $group)

Sets the group of the site (ie wikipedia).

Since
1.21
Parameters
string$group
Exceptions
MWException

Definition at line 194 of file Site.php.

References $group.

Referenced by unserialize().

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

References $internalId.

Referenced by unserialize().

Site::setLanguageCode (   $languageCode)

Sets language code of the sites primary language.

Since
1.21
Parameters
string$languageCode

Definition at line 465 of file Site.php.

References $languageCode.

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

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

References getLinkPathType(), and 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 585 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').

Since
1.21
Parameters
string$source
Exceptions
MWException

Definition at line 222 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.

Since
1.21
Returns
bool

Definition at line 238 of file Site.php.

References $forward.

Referenced by SiteExporter\exportSite().

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

Definition at line 685 of file Site.php.

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

Member Data Documentation

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

Definition at line 108 of file Site.php.

Referenced by getExtraConfig(), serialize(), and setExtraConfig().

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

Definition at line 101 of file Site.php.

Referenced by getExtraData(), serialize(), and setExtraData().

bool Site::$forward = false
protected
Since
1.21

Definition at line 115 of file Site.php.

Referenced by serialize(), and shouldForward().

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

Definition at line 56 of file Site.php.

Referenced by getGlobalId(), serialize(), and setGlobalId().

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

Definition at line 70 of file Site.php.

Referenced by getGroup(), serialize(), and setGroup().

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

Definition at line 122 of file Site.php.

Referenced by getInternalId(), serialize(), and setInternalId().

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

Definition at line 84 of file Site.php.

Referenced by getLanguageCode(), serialize(), and setLanguageCode().

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

Holds the local ids for this site.

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

Since
1.21

Definition at line 94 of file Site.php.

Referenced by getLocalIds(), and serialize().

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

Definition at line 77 of file Site.php.

Referenced by getSource(), serialize(), and setSource().

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

Definition at line 63 of file Site.php.

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

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'
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'

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