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

Inheritance diagram for MediaWiki\Interwiki\InterwikiLookup:

[legend]

Public Member Functions
	fetch ( $prefix)
	Get the Interwiki object for a given prefix. More...

	getAllPrefixes ( $local=null)
	Returns information about all interwiki prefixes, in the form of rows of the interwiki table. More...

	invalidateCache ( $prefix)
	Purge the in-process and any persistent cache (e.g. More...

	isValidInterwiki ( $prefix)
	Check whether an interwiki prefix exists. More...

Detailed Description

Service interface for looking up Interwiki records.

Default implementation is ClassicInterwikiLookup.

Definition at line 32 of file InterwikiLookup.php.

Member Function Documentation

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

Get the Interwiki object for a given prefix.

Parameters

string $prefix Interwiki prefix

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

Returns information about all interwiki prefixes, in the form of rows of the interwiki table.

Each row may have the following keys:

iw_prefix: the prefix. Always present.
iw_url: the URL to use for linking, with $1 as a placeholder for the target page. Always present.
iw_api: the URL of the API. Optional.
iw_wikiid: the wiki ID (usually the database name for local wikis). Optional.
iw_local: whether the wiki is local, and the "magic redirect" mechanism should apply. Defaults to false.
iw_trans: whether "scary transclusion" is allowed for this site. Defaults to false.

Parameters

bool | null $local If set, limit output to local or non-local interwikis

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

Purge the in-process and any persistent cache (e.g.

memcached) for an interwiki prefix.

Parameters

string $prefix

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

Check whether an interwiki prefix exists.

Parameters

string $prefix Interwiki prefix

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