includes/site/SiteLookup.php

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