1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
<?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 {
/**
* Saves the provided site.
*
* @since 1.21
*
* @param Site $site
*
* @return boolean Success indicator
*/
public function saveSite( Site $site );
/**
* Saves the provided sites.
*
* @since 1.21
*
* @param Site[] $sites
*
* @return boolean Success indicator
*/
public function saveSites( array $sites );
/**
* Returns the site with provided global id, or null if there is no such site.
*
* @since 1.21
*
* @param string $globalId
* @param string $source either 'cache' or 'recache'.
* If 'cache', the values are allowed (but not obliged) to come from a cache.
*
* @return Site|null
*/
public function getSite( $globalId, $source = 'cache' );
/**
* Returns a list of all sites. By default this site is
* fetched from the cache, which can be changed to loading
* the list from the database using the $useCache parameter.
*
* @since 1.21
*
* @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' );
/**
* 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();
}
|
