BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
HashSiteStore Class Reference
Inheritance diagram for HashSiteStore:
Collaboration diagram for HashSiteStore:

Public Member Functions

 __construct ($sites=[])
 
 saveSite (Site $site)
 
 saveSites (array $sites)
 
 getSite ($globalId, $source= 'cache')
 
 getSites ($source= 'cache')
 
 clear ()
 
- Public Member Functions inherited from SiteLookup
 getSite ($globalId)
 
 getSites ()
 

Detailed Description

In-memory SiteStore implementation, storing sites in an associative array.

Author
Daniel Kinzler
Katie Filbert < aude..nosp@m.wiki.nosp@m.@gmai.nosp@m.l.co.nosp@m.m >
Since
1.25

Constructor & Destructor Documentation

HashSiteStore::__construct (   $sites = [])
Parameters
Site[]$sites

Member Function Documentation

HashSiteStore::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.

Returns
bool

Implements SiteStore.

HashSiteStore::getSite (   $globalId,
  $source = 'cache' 
)

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

Since
1.25
Parameters
string$globalId
string$sourceeither 'cache' or 'recache'. If 'cache', the values can (but not obliged) come from a cache.
Returns
Site|null
HashSiteStore::getSites (   $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.25
Parameters
string$sourceeither 'cache' or 'recache'. If 'cache', the values can (but not obliged) come from a cache.
Returns
SiteList
HashSiteStore::saveSite ( Site  $site)

Saves the provided site.

Since
1.25
Parameters
Site$site
Returns
bool Success indicator

Implements SiteStore.

HashSiteStore::saveSites ( array  $sites)

Saves the provided sites.

Since
1.25
Parameters
Site[]$sites
Returns
bool Success indicator

Implements SiteStore.


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