Represents a single site. More...

Inheritance 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 null 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)
	Get the full URL for the given page on the site. More...

	getPath ( $pathType)
	Returns the path of the provided type or null 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...

	setExtraConfig (array $extraConfig)
	Sets the type specific config. More...

	setExtraData (array $extraData)
	Sets the type specific fields. More...

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

	setGlobalId (?string $globalId)
	Sets the global site identifier (ie enwiktionary). More...

	setGroup (string $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)
	Set the path used to construct links with. More...

	setPath ( $pathType, string $fullUrl)
	Set the path used to construct links with. More...

	setSource (string $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...

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

Represents a single site.

Since: 1.21

Author: Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Definition at line 32 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 132 of file Site.php.

References $type.

Member Function Documentation

◆ __serialize()

Site::__serialize ( )

See also: Serializable::serialize

Since: 1.38

Returns: array

Definition at line 641 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 663 of file Site.php.

◆ addInterwikiId()

Site::addInterwikiId ( $identifier )

Adds an interwiki id to the site.

Since: 1.21

Parameters

string $identifier

Definition at line 507 of file Site.php.

◆ addLocalId()

Site::addLocalId	(	$type,
		$identifier
	)

Adds a local identifier.

Since: 1.21

Parameters

string	$type
string	$identifier

Definition at line 486 of file Site.php.

References $type.

◆ addNavigationId()

Site::addNavigationId ( $identifier )

Adds a navigation id to the site.

Since: 1.21

Parameters

string $identifier

Definition at line 518 of file Site.php.

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

◆ getDomain()

Site::getDomain ( )

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

Since: 1.21

Returns: string|null

Definition at line 241 of file Site.php.

◆ getExtraConfig()

Site::getExtraConfig ( )

Returns the type specific config.

Since: 1.21

Returns: array

Definition at line 410 of file Site.php.

◆ getExtraData()

Site::getExtraData ( )

Returns the type specific fields.

Since: 1.21

Returns: array

Definition at line 388 of file Site.php.

◆ getGlobalId()

Site::getGlobalId ( )

Returns the global site identifier (ie enwiktionary).

Since: 1.21

Returns: string|null

Definition at line 143 of file Site.php.

References $globalId.

Referenced by HashSiteStore\saveSite().

◆ getGroup()

Site::getGroup ( )

Gets the group of the site (ie wikipedia).

Since: 1.21

Returns: string

Definition at line 175 of file Site.php.

References $group.

◆ getInternalId()

Site::getInternalId ( )

Returns the set internal identifier for the site.

Since: 1.21

Returns: int|null

Definition at line 462 of file Site.php.

◆ getInterwikiIds()

Site::getInterwikiIds ( )

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

Since: 1.21

Returns: string[]

Definition at line 529 of file Site.php.

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

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

References $type.

Referenced by MediaWikiSite\getPageUrl().

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

◆ getLocalIds()

Site::getLocalIds ( )

Returns all local ids.

Since: 1.21

Returns: array[]

Definition at line 556 of file Site.php.

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

◆ getPageUrl()

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

Since: 1.21

Parameters

string | false $pageName

Returns: string|null

Reimplemented in MediaWikiSite.

Definition at line 346 of file Site.php.

◆ getPath()

Site::getPath ( $pathType )

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

Since: 1.21

Parameters

string $pathType

Returns: string|null

Definition at line 586 of file Site.php.

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

◆ getProtocol()

Site::getProtocol ( )

Returns the protocol of the site.

Since: 1.21

Returns: string

Definition at line 263 of file Site.php.

References $path.

◆ getSource()

Site::getSource ( )

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

Since: 1.21

Returns: string

Definition at line 196 of file Site.php.

References $source.

◆ getType()

Site::getType ( )

Returns the type of the site (ie mediawiki).

Since: 1.21

Returns: string

Definition at line 164 of file Site.php.

References $type.

◆ newForType()

static Site::newForType ( $siteType )

static

Since: 1.21

Parameters

string $siteType

Returns: Site

Definition at line 623 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	$followRedirect	either MediaWikiPageNameNormalizer::FOLLOW_REDIRECT or MediaWikiPageNameNormalizer::NOFOLLOW_REDIRECT

Returns: string|false

Reimplemented in MediaWikiSite.

Definition at line 377 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 610 of file Site.php.

◆ setExtraConfig()

Site::setExtraConfig ( array $extraConfig )

Sets the type specific config.

Since: 1.21

Parameters

array $extraConfig

Definition at line 421 of file Site.php.

◆ setExtraData()

Site::setExtraData ( array $extraData )

Sets the type specific fields.

Since: 1.21

Parameters

array $extraData

Definition at line 399 of file Site.php.

◆ setForward()

Site::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.

Since: 1.21

Parameters

bool $shouldForward

Definition at line 229 of file Site.php.

◆ setGlobalId()

Site::setGlobalId ( ?string $globalId )

Sets the global site identifier (ie enwiktionary).

Since: 1.21

Parameters

string | null $globalId

Definition at line 153 of file Site.php.

References $globalId.

◆ setGroup()

Site::setGroup ( string $group )

Sets the group of the site (ie wikipedia).

Since: 1.21

Parameters

string $group

Definition at line 185 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 474 of file Site.php.

◆ setLanguageCode()

Site::setLanguageCode ( $languageCode )

Sets language code of the sites primary language.

Since: 1.21

Parameters

string | null $languageCode

Definition at line 444 of file Site.php.

◆ setLinkPath()

Site::setLinkPath ( $fullUrl )

Set the path used to construct links with.

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

Parameters

string $fullUrl

Since: 1.21

Definition at line 294 of file Site.php.

References $type.

◆ setPath()

Site::setPath	(		$pathType,
		string	$fullUrl
	)

Set the path used to construct links with.

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

Since: 1.21

Parameters

string	$pathType
string	$fullUrl

Definition at line 569 of file Site.php.

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

◆ setSource()

Site::setSource ( string $source )

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

Since: 1.21

Parameters

string $source

Definition at line 206 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 218 of file Site.php.

References $forward.

Member Data Documentation

◆ $extraConfig

array Site::$extraConfig = []

protected

Since: 1.21

Definition at line 111 of file Site.php.

◆ $extraData

array Site::$extraData = []

protected

Since: 1.21

Definition at line 104 of file Site.php.

◆ $forward

bool Site::$forward = false

protected

Since: 1.21

Definition at line 118 of file Site.php.

Referenced by shouldForward().

◆ $globalId

string null Site::$globalId = null

protected

Since: 1.21

Definition at line 59 of file Site.php.

Referenced by getGlobalId(), and setGlobalId().

◆ $group

string Site::$group = self::GROUP_NONE

protected

Since: 1.21

Definition at line 73 of file Site.php.

Referenced by getGroup(), and setGroup().

◆ $internalId

int null Site::$internalId = null

protected

Since: 1.21

Definition at line 125 of file Site.php.

◆ $languageCode

string null Site::$languageCode = null

protected

Since: 1.21

Definition at line 87 of file Site.php.

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

◆ $source

string Site::$source = self::SOURCE_LOCAL

protected

Since: 1.21

Definition at line 80 of file Site.php.

Referenced by getSource(), and setSource().

◆ $type

string Site::$type = self::TYPE_UNKNOWN

protected

Since: 1.21

Definition at line 66 of file Site.php.

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

◆ GROUP_NONE

const Site::GROUP_NONE = 'none'

Definition at line 36 of file Site.php.

Referenced by SiteImporter\makeSite().

◆ ID_EQUIVALENT

const Site::ID_EQUIVALENT = 'equivalent'

Definition at line 39 of file Site.php.

◆ ID_INTERWIKI

const Site::ID_INTERWIKI = 'interwiki'

Definition at line 38 of file Site.php.

◆ PATH_LINK

const Site::PATH_LINK = 'link'

Definition at line 43 of file Site.php.

◆ SOURCE_LOCAL

const Site::SOURCE_LOCAL = 'local'

Definition at line 41 of file Site.php.

Referenced by SiteImporter\makeSite().

◆ TYPE_MEDIAWIKI

const Site::TYPE_MEDIAWIKI = 'mediawiki'

Definition at line 34 of file Site.php.

◆ TYPE_UNKNOWN

const Site::TYPE_UNKNOWN = 'unknown'

Definition at line 33 of file Site.php.

Referenced by SiteImporter\makeSite().

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

includes/site/Site.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __serialize()

◆ __unserialize()

◆ addInterwikiId()

◆ addLocalId()

◆ addNavigationId()

◆ getAllPaths()

◆ getDomain()

◆ getExtraConfig()

◆ getExtraData()

◆ getGlobalId()

◆ getGroup()

◆ getInternalId()

◆ getInterwikiIds()

◆ getLanguageCode()

◆ getLinkPath()

◆ getLinkPathType()

◆ getLocalIds()

◆ getNavigationIds()

◆ getPageUrl()

◆ getPath()

◆ getProtocol()

◆ getSource()

◆ getType()

◆ newForType()

◆ normalizePageName()

◆ removePath()

◆ setExtraConfig()

◆ setExtraData()

◆ setForward()

◆ setGlobalId()

◆ setGroup()

◆ setInternalId()

◆ setLanguageCode()

◆ setLinkPath()

◆ setPath()

◆ setSource()

◆ shouldForward()

Member Data Documentation

◆ $extraConfig

◆ $extraData

◆ $forward

◆ $globalId

◆ $group

◆ $internalId

◆ $languageCode

◆ $localIds

◆ $source

◆ $type

◆ GROUP_NONE

◆ ID_EQUIVALENT

◆ ID_INTERWIKI

◆ PATH_LINK

◆ SOURCE_LOCAL

◆ TYPE_MEDIAWIKI

◆ TYPE_UNKNOWN