MediaWiki  master
SiteLookup Interface Reference

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

Inheritance diagram for SiteLookup:

Public Member Functions

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

Detailed Description

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

Default implementation is DBSiteStore.

Since
1.25

Definition at line 29 of file SiteLookup.php.

Member Function Documentation

◆ getSite()

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 DBSiteStore, and CachingSiteStore.

◆ getSites()

SiteLookup::getSites ( )

Return a list of all sites.

Since
1.25
Returns
SiteList

Implemented in DBSiteStore, and CachingSiteStore.


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