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