Class representing a MediaWiki site. More...

Inheritance diagram for MediaWikiSite:

[legend]

Collaboration diagram for MediaWikiSite:

[legend]

Public Member Functions
	__construct ( $type=self::TYPE_MEDIAWIKI)

	getFileUrl ( $path=false)
	Returns the full file path (ie site url + relative file path).

	getLinkPathType ()

	getPageUrl ( $pageName=false)

	getRelativeFilePath ()
	Returns the relative file path.

	getRelativePagePath ()
	Returns the relative page path.

	normalizePageName ( $pageName, $followRedirect=MediaWikiPageNameNormalizer::FOLLOW_REDIRECT)
	Returns the normalized form of the given page title, using the normalization rules of the given site.

	setFilePath ( $path)
	Sets the relative file path.

	setPagePath ( $path)
	Sets the relative page path.

	toDBKey ( $title)
	Returns the database form of the given title.

Public Member Functions inherited from Site
	__serialize ()

	__unserialize ( $fields)

	addInterwikiId ( $identifier)
	Adds an interwiki id to the site.

	addLocalId ( $type, $identifier)
	Adds a local identifier.

	addNavigationId ( $identifier)
	Adds a navigation id to the site.

	getAllPaths ()
	Returns the paths as associative array.

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

	getExtraConfig ()
	Returns the type specific config.

	getExtraData ()
	Returns the type specific fields.

	getGlobalId ()
	Returns the global site identifier (ie enwiktionary).

	getGroup ()
	Gets the group of the site (ie wikipedia).

	getInternalId ()
	Returns the set internal identifier for the site.

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

	getLanguageCode ()
	Returns language code of the sites primary language.

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

	getLocalIds ()
	Returns all local ids.

	getNavigationIds ()
	Returns the equivalent link identifiers that can be used to make the site show up in interfaces such as the "language links" section.

	getPath ( $pathType)
	Returns the path of the provided type or null if there is no such path.

	getProtocol ()
	Returns the protocol of the site.

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

	getType ()
	Returns the type of the site (ie mediawiki).

	removePath ( $pathType)
	Removes the path of the provided type if it's set.

	serialize ()

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

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

	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.

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

	setGroup ( $group)
	Sets the group of the site (ie wikipedia).

	setInternalId ( $internalId=null)
	Sets the internal identifier for the site.

	setLanguageCode ( $languageCode)
	Sets language code of the sites primary language.

	setLinkPath ( $fullUrl)
	Sets the path used to construct links with.

	setPath ( $pathType, $fullUrl)
	Sets the path used to construct links with.

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

	shouldForward ()
	Gets if site.tld/path/key:pageTitle should forward users to the page on the actual site, where "key" is the local identifier.

	unserialize ( $serialized)

Public Attributes
const	PATH_FILE = 'file_path'

const	PATH_PAGE = 'page_path'

Public Attributes inherited from Site
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'

Additional Inherited Members
Static Public Member Functions inherited from Site
static	newForType ( $siteType)

Protected Attributes inherited from Site
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.

string	$source = self::SOURCE_LOCAL

string	$type = self::TYPE_UNKNOWN

Detailed Description

Class representing a MediaWiki site.

Since: 1.21

Definition at line 38 of file MediaWikiSite.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWikiSite::__construct ( $type = self::TYPE_MEDIAWIKI )

Since: 1.21

Parameters

string $type

Reimplemented from Site.

Definition at line 47 of file MediaWikiSite.php.

References $type.

Member Function Documentation

◆ getFileUrl()

MediaWikiSite::getFileUrl ( $path = false )

Returns the full file path (ie site url + relative file path).

The path should go at the $1 marker. If the $path argument is provided, the marker will be replaced by it's value.

Since: 1.21

Parameters

string | bool $path

Returns: string

Exceptions

MWException If the file path cannot be determined.

Definition at line 213 of file MediaWikiSite.php.

References $path, and Site\getPath().

Referenced by normalizePageName().

◆ getLinkPathType()

MediaWikiSite::getLinkPathType ( )

See also: Site::getLinkPathType Returns Site::PATH_PAGE

Since: 1.21

Returns: string

Reimplemented from Site.

Definition at line 124 of file MediaWikiSite.php.

◆ getPageUrl()

MediaWikiSite::getPageUrl ( $pageName = false )

See also: Site::getPageUrl

This implementation returns a URL constructed using the path returned by getLinkPath(). In addition to the default behavior implemented by Site::getPageUrl(), this method converts the $pageName to DBKey-format by replacing spaces with underscores before using it in the URL.

Since: 1.21

Parameters

string | bool $pageName Page name or false (default: false)

Returns: string|null

Reimplemented from Site.

Definition at line 186 of file MediaWikiSite.php.

References Site\getLinkPath(), toDBKey(), and wfUrlencode().

◆ getRelativeFilePath()

MediaWikiSite::getRelativeFilePath ( )

Returns the relative file path.

Since: 1.21

Returns: string

Definition at line 146 of file MediaWikiSite.php.

References Site\getPath().

◆ getRelativePagePath()

MediaWikiSite::getRelativePagePath ( )

Returns the relative page path.

Since: 1.21

Returns: string

Definition at line 135 of file MediaWikiSite.php.

References Site\getPath().

◆ normalizePageName()

MediaWikiSite::normalizePageName	(		$pageName,
			$followRedirect = MediaWikiPageNameNormalizer::FOLLOW_REDIRECT )

Returns the normalized form of the given page title, using the normalization rules of the given site.

If $followRedirect is set to true and the given title is a redirect, the redirect will be resolved and the redirect target is returned. Only titles of existing pages will be returned.

Note: This actually makes an API request to the remote site, so beware that this function is slow and depends on an external service.; If MW_PHPUNIT_TEST is defined, the call to the external site is skipped, and the title is normalized using the local normalization rules as implemented by the Title class.

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 The normalized form of the title, or false to indicate an invalid title, a missing page, or some other kind of error.

Exceptions

MWException

Reimplemented from Site.

Definition at line 92 of file MediaWikiSite.php.

References $t, and getFileUrl().

◆ setFilePath()

MediaWikiSite::setFilePath ( $path )

Sets the relative file path.

Since: 1.21

Parameters

string $path

Definition at line 168 of file MediaWikiSite.php.

References $path, and Site\setPath().

◆ setPagePath()

MediaWikiSite::setPagePath ( $path )

Sets the relative page path.

Since: 1.21

Parameters

string $path

Definition at line 157 of file MediaWikiSite.php.

References $path, and Site\setPath().

◆ toDBKey()

MediaWikiSite::toDBKey ( $title )

Returns the database form of the given title.

Since: 1.21

Parameters

string $title The target page's title, in normalized form.

Returns: string

Definition at line 60 of file MediaWikiSite.php.

References $title.

Referenced by getPageUrl().

Member Data Documentation

◆ PATH_FILE

const MediaWikiSite::PATH_FILE = 'file_path'

Definition at line 39 of file MediaWikiSite.php.

◆ PATH_PAGE

const MediaWikiSite::PATH_PAGE = 'page_path'

Definition at line 40 of file MediaWikiSite.php.

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

includes/site/MediaWikiSite.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFileUrl()

◆ getLinkPathType()

◆ getPageUrl()

◆ getRelativeFilePath()

◆ getRelativePagePath()

◆ normalizePageName()

◆ setFilePath()

◆ setPagePath()

◆ toDBKey()

Member Data Documentation

◆ PATH_FILE

◆ PATH_PAGE