diff options
Diffstat (limited to 'includes/site/SiteLookup.php')
-rw-r--r-- | includes/site/SiteLookup.php | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/includes/site/SiteLookup.php b/includes/site/SiteLookup.php new file mode 100644 index 00000000..610bf0b7 --- /dev/null +++ b/includes/site/SiteLookup.php @@ -0,0 +1,50 @@ +<?php + +/** + * Interface for service objects providing a lookup of Site objects. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @since 1.25 + * + * @file + * @ingroup Site + * + * @license GNU GPL v2+ + */ +interface SiteLookup { + + /** + * Returns the site with provided global id, or null if there is no such site. + * + * @since 1.25 + * + * @param string $globalId + * + * @return Site|null + */ + public function getSite( $globalId ); + + /** + * Returns a list of all sites. + * + * @since 1.25 + * + * @return SiteList + */ + public function getSites(); + +} |