b45420410f
Swapped some "$var type" to "type $var" or added missing types before the $var. Changed some other types to match the more common spelling. Makes beginning of some text in captial. Also added some missing @param. Change-Id: Iced714bca004756b461b66067a49a925a7e3b877
85 lines
2.3 KiB
PHP
85 lines
2.3 KiB
PHP
<?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 bool Success indicator
|
|
*/
|
|
public function saveSite( Site $site );
|
|
|
|
/**
|
|
* Saves the provided sites.
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param Site[] $sites
|
|
*
|
|
* @return bool 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();
|
|
}
|