MediaWiki\Site\SiteLookup Interface Reference

Interface to retrieve Site objects, for implementation by service classes. More...

Inherited by MediaWiki\Site\SiteStore.

Public Member Functions
	getSite ( $globalId)
	Return the site with provided global ID, or null if there is no such site.
	getSites ()
	Return a list of all sites.

Detailed Description

Interface to retrieve Site objects, for implementation by service classes.

Default implementation is DBSiteStore.

Since

1.25

Definition at line 31 of file SiteLookup.php.

Member Function Documentation

getSite()

MediaWiki\Site\SiteLookup::getSite

(

$globalId

)

Return the site with provided global ID, or null if there is no such site.

Since

1.25

Parameters

string

$globalId

Returns

Site|null

Implemented in MediaWiki\Site\CachingSiteStore, and MediaWiki\Site\DBSiteStore.

getSites()

MediaWiki\Site\SiteLookup::getSites

(

)

Return a list of all sites.

Since

1.25

Returns

SiteList

Implemented in MediaWiki\Site\CachingSiteStore, and MediaWiki\Site\DBSiteStore.

---

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

• includes/site/SiteLookup.php