Class representing a MediaWiki site. More...

Inheritance diagram for MediaWikiSite:

Collaboration diagram for MediaWikiSite:

Public Member Functions
	__construct ($type=self::TYPE_MEDIAWIKI)
	Constructor.
	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)
	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.
Static Public Member Functions
static	newFromGlobalId ($globalId)
Public Attributes
const	PATH_FILE = 'file_path'
const	PATH_PAGE = 'page_path'
Static Private Member Functions
static	extractPageRecord ($externalData, $pageTitle)
	Get normalization record for a given page title from an API response.

Detailed Description

Class representing a MediaWiki site.

Since:: 1.21

Definition at line 35 of file MediaWikiSite.php.

Constructor & Destructor Documentation

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

Constructor.

Since:: 1.21

Parameters:

string $type

Reimplemented from Site.

Definition at line 61 of file MediaWikiSite.php.

References Site\$type.

Member Function Documentation

static MediaWikiSite::extractPageRecord	(	$	externalData,
		$	pageTitle
	)		`[static, private]`

Get normalization record for a given page title from an API response.

Since:: 1.21

Parameters:

array	$externalData	A reply from the API on a external server.
string	$pageTitle	Identifies the page at the external site, needing normalization.

Returns:: array|boolean a 'page' structure representing the page identified by $pageTitle.

Definition at line 182 of file MediaWikiSite.php.

References array(), as, and use.

Referenced by normalizePageName().

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 | boolean $path

Returns:: string

Definition at line 342 of file MediaWikiSite.php.

References $path, and Site\getPath().

Referenced by normalizePageName().

MediaWikiSite::getLinkPathType ( )

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

Since:: 1.21

Returns:: string

Reimplemented from Site.

Definition at line 254 of file MediaWikiSite.php.

References PATH_PAGE.

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 | boolean $pageName Page name or false (default: false)

Returns:: string

Reimplemented from Site.

Definition at line 316 of file MediaWikiSite.php.

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

MediaWikiSite::getRelativeFilePath ( )

Returns the relative file path.

Since:: 1.21

Returns:: string

Definition at line 276 of file MediaWikiSite.php.

References Site\getPath().

MediaWikiSite::getRelativePagePath ( )

Returns the relative page path.

Since:: 1.21

Returns:: string

Definition at line 265 of file MediaWikiSite.php.

References Site\getPath().

static MediaWikiSite::newFromGlobalId ( $ globalId ) [static]

Since:: 1.21

Deprecated:: Just use the constructor or the factory Site::newForType

Parameters:

integer $globalId

Returns:: MediaWikiSite

Definition at line 48 of file MediaWikiSite.php.

References Site\$globalId.

MediaWikiSite::normalizePageName ( $ pageName )

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

If the given title is a redirect, the redirect weill be resolved and the redirect target is 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.