SiteStore Interface Reference

Inheritance diagram for SiteStore:

Collaboration diagram for SiteStore:

Public Member Functions
	clear ()
	Deletes all sites from the database.
	saveSite (Site $site)
	Saves the provided site.
	saveSites (array $sites)
	Saves the provided sites.
Public Member Functions inherited from SiteLookup
	getSite ( $globalId)
	Returns the site with provided global id, or null if there is no such site.
	getSites ()
	Returns a list of all sites.

Detailed Description

Definition at line 29 of file SiteStore.php.

Member Function Documentation

clear()

SiteStore::clear

(

)

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.

Implemented in CachingSiteStore, DBSiteStore, and HashSiteStore.

saveSite()

SiteStore::saveSite

(

Site

$site

)

Saves the provided site.

Since

1.21

Parameters

Site

$site

Returns

bool Success indicator

Implemented in CachingSiteStore, DBSiteStore, and HashSiteStore.

saveSites()

SiteStore::saveSites

(

array

$sites

)

Saves the provided sites.

Since

1.21

Parameters

Site[]

$sites

Returns

bool Success indicator

Implemented in CachingSiteStore, DBSiteStore, and HashSiteStore.

---

The documentation for this interface was generated from the following file:

• includes/site/SiteStore.php