Elgg  Version 3.0
Public Member Functions | Protected Attributes | List of all members
Elgg\Cache\PrivateSettingsCache Class Reference

In memory cache of known private settings values stored by entity. More...

Public Member Functions

 __construct (ElggCache $cache)
 Constructor. More...
 
 load ($key)
 Load data from the cache using a given key. More...
 
 save ($key, $data, $expire_after=null)
 Save data in a cache. More...
 
 populateFromEntities (...$guids)
 Populate the cache from a set of entities. More...
 

Protected Attributes

 $cache
 

Detailed Description

In memory cache of known private settings values stored by entity.

Definition at line 12 of file PrivateSettingsCache.php.

Constructor & Destructor Documentation

Elgg\Cache\PrivateSettingsCache::__construct ( ElggCache  $cache)

Constructor.

Parameters
ElggCache$cacheCache

Definition at line 24 of file PrivateSettingsCache.php.

Member Function Documentation

Elgg\Cache\PrivateSettingsCache::load (   $key)

Load data from the cache using a given key.

Parameters
string$keyName
Returns
mixed|null The stored data or null if it's a miss

Definition at line 35 of file PrivateSettingsCache.php.

Elgg\Cache\PrivateSettingsCache::populateFromEntities (   $guids)

Populate the cache from a set of entities.

Parameters
int[]...$guids Array of or single GUIDs
Returns
array|null [guid => [settings]]

Definition at line 58 of file PrivateSettingsCache.php.

Elgg\Cache\PrivateSettingsCache::save (   $key,
  $data,
  $expire_after = null 
)

Save data in a cache.

Parameters
string$keyName
mixed$dataValue
int$expire_afterNumber of seconds to expire the cache after
Returns
bool

Definition at line 48 of file PrivateSettingsCache.php.

Member Data Documentation

Elgg\Cache\PrivateSettingsCache::$cache
protected

Definition at line 17 of file PrivateSettingsCache.php.


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