Code Coverage for /workspace/src/includes/site/SiteLookup.php

1	<?php
2	/**
3	* This program is free software; you can redistribute it and/or modify
4	* it under the terms of the GNU General Public License as published by
5	* the Free Software Foundation; either version 2 of the License, or
6	* (at your option) any later version.
7	*
8	* This program is distributed in the hope that it will be useful,
9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11	* GNU General Public License for more details.
12	*
13	* You should have received a copy of the GNU General Public License along
14	* with this program; if not, write to the Free Software Foundation, Inc.,
15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16	* http://www.gnu.org/copyleft/gpl.html
17	*
18	* @file
19	*/
20
21	namespace MediaWiki\Site;
22
23	/**
24	* Interface to retrieve Site objects, for implementation by service classes.
25	*
26	* Default implementation is DBSiteStore.
27	*
28	* @since 1.25
29	* @ingroup Site
30	*/
31	interface SiteLookup {
32
33	/**
34	* Return the site with provided global ID, or null if there is no such site.
35	*
36	* @since 1.25
37	* @param string $globalId
38	* @return Site\|null
39	*/
40	public function getSite( $globalId );
41
42	/**
43	* Return a list of all sites.
44	*
45	* @since 1.25
46	* @return SiteList
47	*/
48	public function getSites();
49
50	}
51
52	/** @deprecated class alias since 1.42 */
53	class_alias( SiteLookup::class, 'SiteLookup' );