includes/site/SiteStore.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 for storing and retrieving Site objects.
  25  *
  26  * Default implementation is DBSiteStore.
  27  *
  28  * @since 1.21
  29  * @ingroup Site
  30  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  31  */
  32 interface SiteStore extends SiteLookup {
  33
  34         /**
  35          * Saves the provided site.
  36          *
  37          * @since 1.21
  38          * @param Site $site
  39          * @return bool Success indicator
  40          */
  41         public function saveSite( Site $site );
  42
  43         /**
  44          * Saves the provided sites.
  45          *
  46          * @since 1.21
  47          * @param Site[] $sites
  48          * @return bool Success indicator
  49          */
  50         public function saveSites( array $sites );
  51
  52         /**
  53          * Deletes all sites from the database. After calling clear(), getSites() will return an empty
  54          * list and getSite() will return null until saveSite() or saveSites() is called.
  55          */
  56         public function clear();
  57 }
  58
  59 /** @deprecated class alias since 1.42 */
  60 class_alias( SiteStore::class, 'SiteStore' );