PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of SiteStore.php

(no description)

File Size:	85 lines (2 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

SiteStore:: (5 methods):
  saveSite()
  saveSites()
  getSite()
  getSites()
  clear()

Interface: SiteStore - X-Ref

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

saveSite( Site $site ) X-Ref

Saves the provided site.

param: Site $site
return: bool Success indicator

saveSites( array $sites ) X-Ref

Saves the provided sites.

param: Site[] $sites
return: bool Success indicator

getSite( $globalId, $source = 'cache' ) X-Ref

Returns the site with provided global id, or null if there is no such site.

param: string $globalId
param: string $source Either 'cache' or 'recache'.
return: Site|null

getSites( $source = 'cache' ) X-Ref

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.

param: string $source Either 'cache' or 'recache'.
return: SiteList

clear() X-Ref

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.

PHP Cross Reference of MediaWiki-1.24.0

/includes/site/ -> SiteStore.php (summary)

Defines 1 class