Merge "Declare visibility on class properties of CdbPHP.php"

[lhc/web/wiklou.git] / includes / site / SiteStore.php

diff --git a/includes/site/SiteStore.php b/includes/site/SiteStore.php
index 2091f3c..537f1cc 100644 (file)
--- a/includes/site/SiteStore.php
+++ b/includes/site/SiteStore.php
@@ -1,5 +1,31 @@
 <?php
 
+/**
+ * Interface for service objects providing a storage interface for 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.21
+ *
+ * @file
+ * @ingroup Site
+ *
+ * @license GNU GPL v2+
+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
+ */
 interface SiteStore {
 
        /**
@@ -9,7 +35,7 @@ interface SiteStore {
         *
         * @param Site $site
         *
-        * @return boolean Success indicator
+        * @return bool Success indicator
         */
        public function saveSite( Site $site );
 
@@ -20,7 +46,7 @@ interface SiteStore {
         *
         * @param Site[] $sites
         *
-        * @return boolean Success indicator
+        * @return bool Success indicator
         */
        public function saveSites( array $sites );
 
@@ -30,7 +56,7 @@ interface SiteStore {
         * @since 1.21
         *
         * @param string $globalId
-        * @param string $source either 'cache' or 'recache'.
+        * @param string $source Either 'cache' or 'recache'.
         * If 'cache', the values are allowed (but not obliged) to come from a cache.
         *
         * @return Site|null
@@ -44,11 +70,16 @@ interface SiteStore {
         *
         * @since 1.21
         *
-        * @param string $source either 'cache' or 'recache'.
+        * @param string $source Either 'cache' or 'recache'.
         * If 'cache', the values are allowed (but not obliged) to come from a cache.
         *
         * @return SiteList
         */
        public function getSites( $source = 'cache' );
 
-}
\ No newline at end of file
+       /**
+        * Deletes all sites from the database. After calling clear(), getSites() will return an empty
+        * list and getSite() will return null until saveSite() or saveSites() is called.
+        */
+       public function clear();
+}