MediaWiki
master
|
InterwikiLookup implementing the "classic" interwiki storage (hardcoded up to MW 1.26). More...
Public Member Functions | |
__construct (Language $contLang, WANObjectCache $objectCache, HookContainer $hookContainer, ILoadBalancer $loadBalancer, $objectCacheExpiry, $interwikiData, $interwikiScopes, $fallbackSite) | |
fetch ( $prefix) | |
Fetch an Interwiki object. More... | |
getAllPrefixes ( $local=null) | |
Returns all interwiki prefixes. More... | |
invalidateCache ( $prefix) | |
Purge the in-process and object cache for an interwiki prefix. More... | |
isValidInterwiki ( $prefix) | |
Check whether an interwiki prefix exists. More... | |
resetLocalCache () | |
Resets locally cached Interwiki objects. More... | |
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. More... | |
Private Member Functions | |
fetchPregenerated ( $prefix) | |
Fetch interwiki prefix data from local cache in constant database. More... | |
getAllPrefixesDB ( $local) | |
Fetch all interwiki prefixes from DB. More... | |
getAllPrefixesPregenerated ( $local) | |
Fetch all interwiki prefixes from pregenerated data. More... | |
getPregeneratedEntry ( $prefix) | |
Get entry from pregenerated data. More... | |
load ( $prefix) | |
Load the interwiki, trying first memcached then the DB. More... | |
loadFromArray ( $mc) | |
Fill in member variables from an array (e.g. More... | |
Static Private Member Functions | |
static | selectFields () |
Return the list of interwiki fields that should be selected to create a new Interwiki object. More... | |
Private Attributes | |
Language | $contLang |
array null | $data |
Complete pregenerated data if available. More... | |
string | $fallbackSite |
HookRunner | $hookRunner |
int | $interwikiScopes |
ILoadBalancer | $loadBalancer |
MapCacheLRU | $localCache |
WANObjectCache | $objectCache |
int | $objectCacheExpiry |
string null | $thisSite = null |
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)
Definition at line 48 of file ClassicInterwikiLookup.php.
MediaWiki\Interwiki\ClassicInterwikiLookup::__construct | ( | Language | $contLang, |
WANObjectCache | $objectCache, | ||
HookContainer | $hookContainer, | ||
ILoadBalancer | $loadBalancer, | ||
$objectCacheExpiry, | |||
$interwikiData, | |||
$interwikiScopes, | |||
$fallbackSite | |||
) |
Language | $contLang | Language object used to convert prefixes to lower case |
WANObjectCache | $objectCache | Cache for interwiki info retrieved from the database |
HookContainer | $hookContainer | |
ILoadBalancer | $loadBalancer | |
int | $objectCacheExpiry | Expiry time for $objectCache, in seconds |
bool | array | $interwikiData | The pre-generated interwiki data, or false to use the database. |
int | $interwikiScopes | Specify number of domains to check for messages:
|
string | $fallbackSite | The code to assume for the local site, |
Definition at line 110 of file ClassicInterwikiLookup.php.
References MediaWiki\Interwiki\ClassicInterwikiLookup\$contLang, MediaWiki\Interwiki\ClassicInterwikiLookup\$fallbackSite, MediaWiki\Interwiki\ClassicInterwikiLookup\$interwikiScopes, MediaWiki\Interwiki\ClassicInterwikiLookup\$loadBalancer, MediaWiki\Interwiki\ClassicInterwikiLookup\$objectCache, and MediaWiki\Interwiki\ClassicInterwikiLookup\$objectCacheExpiry.
|
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).
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. |
Definition at line 382 of file ClassicInterwikiLookup.php.
MediaWiki\Interwiki\ClassicInterwikiLookup::fetch | ( | $prefix | ) |
Fetch an Interwiki object.
string | $prefix | Interwiki prefix to use |
Implements MediaWiki\Interwiki\InterwikiLookup.
Definition at line 155 of file ClassicInterwikiLookup.php.
References MediaWiki\Interwiki\ClassicInterwikiLookup\fetchPregenerated(), and MediaWiki\Interwiki\ClassicInterwikiLookup\load().
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\isValidInterwiki().
|
private |
Fetch interwiki prefix data from local cache in constant database.
string | $prefix | Interwiki prefix |
Definition at line 206 of file ClassicInterwikiLookup.php.
References MediaWiki\Interwiki\ClassicInterwikiLookup\getPregeneratedEntry().
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\fetch().
MediaWiki\Interwiki\ClassicInterwikiLookup::getAllPrefixes | ( | $local = null | ) |
Returns all interwiki prefixes.
string | null | $local | If set, limits output to local/non-local interwikis |
Implements MediaWiki\Interwiki\InterwikiLookup.
Definition at line 439 of file ClassicInterwikiLookup.php.
|
private |
Fetch all interwiki prefixes from DB.
bool | null | $local | If not null, limits output to local/non-local interwikis |
Definition at line 411 of file ClassicInterwikiLookup.php.
References $res, and DB_REPLICA.
|
private |
Fetch all interwiki prefixes from pregenerated data.
null | string | $local | If not null, limits output to local/non-local interwikis |
Definition at line 321 of file ClassicInterwikiLookup.php.
References MediaWiki\Interwiki\ClassicInterwikiLookup\$data, MediaWiki\Interwiki\ClassicInterwikiLookup\$fallbackSite, $source, MediaWiki\Interwiki\ClassicInterwikiLookup\$thisSite, WikiMap\getCurrentWikiId(), and wfDebug().
|
private |
Get entry from pregenerated data.
string | $prefix | Database key |
Definition at line 226 of file ClassicInterwikiLookup.php.
References MediaWiki\Interwiki\ClassicInterwikiLookup\$fallbackSite, WikiMap\getCurrentWikiId(), and wfDebug().
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\fetchPregenerated().
MediaWiki\Interwiki\ClassicInterwikiLookup::invalidateCache | ( | $prefix | ) |
Purge the in-process and object cache for an interwiki prefix.
string | $prefix |
Implements MediaWiki\Interwiki\InterwikiLookup.
Definition at line 191 of file ClassicInterwikiLookup.php.
MediaWiki\Interwiki\ClassicInterwikiLookup::isValidInterwiki | ( | $prefix | ) |
Check whether an interwiki prefix exists.
string | $prefix | Interwiki prefix to use |
Implements MediaWiki\Interwiki\InterwikiLookup.
Definition at line 143 of file ClassicInterwikiLookup.php.
References MediaWiki\Interwiki\ClassicInterwikiLookup\fetch().
|
private |
Load the interwiki, trying first memcached then the DB.
string | $prefix | The interwiki prefix |
Definition at line 255 of file ClassicInterwikiLookup.php.
References $dbr, DB_REPLICA, Wikimedia\Rdbms\Database\getCacheSetOptions(), and MediaWiki\Interwiki\ClassicInterwikiLookup\loadFromArray().
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\fetch().
|
private |
Fill in member variables from an array (e.g.
memcached result, Database::fetchRow, etc)
array | $mc | Associative array: row from the interwiki table |
Definition at line 301 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\load().
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.
Definition at line 183 of file ClassicInterwikiLookup.php.
|
staticprivate |
Return the list of interwiki fields that should be selected to create a new Interwiki object.
Definition at line 452 of file ClassicInterwikiLookup.php.
|
private |
Definition at line 58 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\__construct().
|
private |
Complete pregenerated data if available.
Definition at line 73 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesPregenerated().
|
private |
|
private |
Definition at line 91 of file ClassicInterwikiLookup.php.
|
private |
Definition at line 78 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\__construct().
|
private |
Definition at line 94 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\__construct().
|
private |
Definition at line 53 of file ClassicInterwikiLookup.php.
|
private |
Definition at line 63 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\__construct().
|
private |
Definition at line 68 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\__construct().
|
private |
Definition at line 88 of file ClassicInterwikiLookup.php.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesPregenerated().