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 0d8dcdf..537f1cc 100644 (file)
--- a/includes/site/SiteStore.php
+++ b/includes/site/SiteStore.php
@@ -35,7 +35,7 @@ interface SiteStore {
         *
         * @param Site $site
         *
-        * @return boolean Success indicator
+        * @return bool Success indicator
         */
        public function saveSite( Site $site );
 
@@ -46,7 +46,7 @@ interface SiteStore {
         *
         * @param Site[] $sites
         *
-        * @return boolean Success indicator
+        * @return bool Success indicator
         */
        public function saveSites( array $sites );
 
@@ -56,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
@@ -70,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();
+}