MediaWiki REL1_39
MediaWiki\Interwiki\ClassicInterwikiLookup Class Reference

InterwikiLookup implementing the "classic" interwiki storage (hardcoded up to MW 1.26). More...

Inheritance diagram for MediaWiki\Interwiki\ClassicInterwikiLookup:
Collaboration diagram for MediaWiki\Interwiki\ClassicInterwikiLookup:

Public Member Functions

 __construct (Language $contLang, WANObjectCache $objectCache, HookContainer $hookContainer, ILoadBalancer $loadBalancer, $objectCacheExpiry, $interwikiData, $interwikiScopes, $fallbackSite)
 
 fetch ( $prefix)
 Fetch an Interwiki object.
 
 getAllPrefixes ( $local=null)
 Returns all interwiki prefixes.
 
 invalidateCache ( $prefix)
 Purge the in-process and object cache for an interwiki prefix.
 
 isValidInterwiki ( $prefix)
 Check whether an interwiki prefix exists.
 
 resetLocalCache ()
 Resets locally cached Interwiki objects.
 

Static Public Member Functions

static buildCdbHash (array $allPrefixes, int $scope=1, ?string $thisSite=null)
 Given the array returned by getAllPrefixes(), build a PHP hash which can be given to self::__construct() as $interwikiData, i.e.
 

Detailed Description

InterwikiLookup implementing the "classic" interwiki storage (hardcoded up to MW 1.26).

This implements two levels of caching (in-process array and a WANObjectCache) and two storage backends (SQL and plain PHP arrays).

All information is loaded on creation when called by $this->fetch( $prefix ). All work is done on replica DB, because this should never change (except during schema updates etc, which aren't wiki-related)

Since
1.28

Definition at line 48 of file ClassicInterwikiLookup.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Interwiki\ClassicInterwikiLookup::__construct ( Language $contLang,
WANObjectCache $objectCache,
HookContainer $hookContainer,
ILoadBalancer $loadBalancer,
$objectCacheExpiry,
$interwikiData,
$interwikiScopes,
$fallbackSite )
Parameters
Language$contLangLanguage object used to convert prefixes to lower case
WANObjectCache$objectCacheCache for interwiki info retrieved from the database
HookContainer$hookContainer
ILoadBalancer$loadBalancer
int$objectCacheExpiryExpiry time for $objectCache, in seconds
bool | array$interwikiDataThe pre-generated interwiki data, or false to use the database.
int$interwikiScopesSpecify number of domains to check for messages:
  • 1: Just local wiki level
  • 2: wiki and global levels
  • 3: site level as well as wiki and global levels
string$fallbackSiteThe code to assume for the local site,

Definition at line 110 of file ClassicInterwikiLookup.php.

Member Function Documentation

◆ buildCdbHash()

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

Given the array returned by getAllPrefixes(), build a PHP hash 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$allPrefixesAn array of interwiki information such as would be returned by ::getAllPrefixes()
int$scopeThe scope at which to insert interwiki prefixes. See the $interwikiScopes parameter to ::__construct().
?string$thisSiteThe value of $thisSite, if $scope is 3.
Returns
array A PHP associative array suitable to use as $wgInterwikiCache

Definition at line 382 of file ClassicInterwikiLookup.php.

◆ fetch()

MediaWiki\Interwiki\ClassicInterwikiLookup::fetch ( $prefix)

Fetch an Interwiki object.

Parameters
string$prefixInterwiki prefix to use
Returns
Interwiki|null|bool

Implements MediaWiki\Interwiki\InterwikiLookup.

Definition at line 155 of file ClassicInterwikiLookup.php.

Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\isValidInterwiki().

◆ getAllPrefixes()

MediaWiki\Interwiki\ClassicInterwikiLookup::getAllPrefixes ( $local = null)

Returns all interwiki prefixes.

Parameters
string | null$localIf set, limits output to local/non-local interwikis
Returns
array[] Interwiki rows, where each row is an associative array

Implements MediaWiki\Interwiki\InterwikiLookup.

Definition at line 439 of file ClassicInterwikiLookup.php.

◆ invalidateCache()

MediaWiki\Interwiki\ClassicInterwikiLookup::invalidateCache ( $prefix)

Purge the in-process and object cache for an interwiki prefix.

Parameters
string$prefix

Implements MediaWiki\Interwiki\InterwikiLookup.

Definition at line 191 of file ClassicInterwikiLookup.php.

◆ isValidInterwiki()

MediaWiki\Interwiki\ClassicInterwikiLookup::isValidInterwiki ( $prefix)

Check whether an interwiki prefix exists.

Parameters
string$prefixInterwiki prefix to use
Returns
bool Whether it exists

Implements MediaWiki\Interwiki\InterwikiLookup.

Definition at line 143 of file ClassicInterwikiLookup.php.

References MediaWiki\Interwiki\ClassicInterwikiLookup\fetch().

◆ resetLocalCache()

MediaWiki\Interwiki\ClassicInterwikiLookup::resetLocalCache ( )

Resets locally cached Interwiki objects.

This is intended for use during testing only. This does not invalidate entries in the persistent cache, as invalidateCache() does.

Since
1.27

Definition at line 183 of file ClassicInterwikiLookup.php.


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