MediaWiki  1.29.2
MediaWiki\Interwiki\InterwikiLookup Interface Reference

Service interface for looking up Interwiki records. More...

Inheritance diagram for MediaWiki\Interwiki\InterwikiLookup:

Public Member Functions

 fetch ( $prefix)
 Fetch an Interwiki object. More...
 
 getAllPrefixes ( $local=null)
 Returns all interwiki prefixes. More...
 
 invalidateCache ( $prefix)
 Purge the in-process and persistent object cache for an interwiki prefix. More...
 
 isValidInterwiki ( $prefix)
 Check whether an interwiki prefix exists. More...
 

Detailed Description

Service interface for looking up Interwiki records.

Since
1.28

Definition at line 31 of file InterwikiLookup.php.

Member Function Documentation

◆ fetch()

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

Fetch an Interwiki object.

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

Implemented in MediaWiki\Interwiki\ClassicInterwikiLookup, and MediaWiki\Interwiki\InterwikiLookupAdapter.

◆ getAllPrefixes()

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

Returns all interwiki prefixes.

Parameters
string | null$localIf set, limits output to local/non-local interwikis
Returns
string[] List of prefixes

Implemented in MediaWiki\Interwiki\ClassicInterwikiLookup, and MediaWiki\Interwiki\InterwikiLookupAdapter.

◆ invalidateCache()

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

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

Parameters
string$prefix

Implemented in MediaWiki\Interwiki\ClassicInterwikiLookup, and MediaWiki\Interwiki\InterwikiLookupAdapter.

◆ isValidInterwiki()

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

Check whether an interwiki prefix exists.

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

Implemented in MediaWiki\Interwiki\ClassicInterwikiLookup, and MediaWiki\Interwiki\InterwikiLookupAdapter.


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