InterwikiLookup backed by the interwiki database table or $wgInterwikiCache. More...

Inherits MediaWiki\Interwiki\InterwikiLookup.

Collaboration diagram for MediaWiki\Interwiki\ClassicInterwikiLookup:

Public Member Functions

__construct (ServiceOptions $options, Language $contLang, WANObjectCache $wanCache, HookContainer $hookContainer, IConnectionProvider $dbProvider)

fetch ( $prefix)

Get the Interwiki object for a given prefix.

Parameters

string $prefix Interwiki prefix

Returns: Interwiki|null|false Null for invalid, false for not found

getAllPrefixes ( $local=null)

Fetch all interwiki data.

invalidateCache ( $prefix)

Purge the instance cache and memcached for an interwiki prefix.

isValidInterwiki ( $prefix)

Check whether an interwiki prefix exists.

Parameters

string $prefix Interwiki prefix

Returns: bool Whether it exists

Static Public Member Functions
static	buildCdbHash (array $allPrefixes, int $scope=1, ?string $thisSite=null)
	Build an array in the format accepted by $wgInterwikiCache.

Detailed Description

InterwikiLookup backed by the interwiki database table or $wgInterwikiCache.

By default this uses the SQL backend (interwiki database table) and includes two levels of caching. When parsing a wiki page, many interwiki lookups may be required and thus there is in-class caching for repeat lookups. To reduce database pressure, there is also WANObjectCache for each prefix.

Optionally, a pregenerated dataset can be statically set via $wgInterwikiCache, in which case there are no calls to either database or WANObjectCache.

Since: 1.28

Definition at line 47 of file ClassicInterwikiLookup.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Interwiki\ClassicInterwikiLookup::__construct	(	ServiceOptions	$options,
		Language	$contLang,
		WANObjectCache	$wanCache,
		HookContainer	$hookContainer,
		IConnectionProvider	$dbProvider )

Parameters

ServiceOptions	$options
Language	$contLang	Language object used to convert prefixes to lower case
WANObjectCache	$wanCache	Cache for interwiki info retrieved from the database
HookContainer	$hookContainer
IConnectionProvider	$dbProvider

Definition at line 94 of file ClassicInterwikiLookup.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\Config\ServiceOptions\get(), MediaWiki\MainConfigNames\InterwikiCache, and MediaWiki\MainConfigNames\InterwikiScopes.

Member Function Documentation

◆ buildCdbHash()

static MediaWiki\Interwiki\ClassicInterwikiLookup::buildCdbHash	(	array	$allPrefixes,
		int	$scope = 1,
		?string	$thisSite = null )

static

Build an array in the format accepted by $wgInterwikiCache.

Given the array returned by getAllPrefixes(), build a PHP array which can be given to self::__construct() as $interwikiData, i.e. as the value of $wgInterwikiCache. This is used to construct mock interwiki lookup services for testing (in particular, parsertests).

Parameters

array	$allPrefixes	An array of interwiki information such as would be returned by ::getAllPrefixes()
int	$scope	The scope at which to insert interwiki prefixes. See the $interwikiScopes parameter to ::__construct().
?string	$thisSite	The value of $thisSite, if $scope is 3.