Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Elgg\Cache\SystemCache Class Reference

Public Member Functions

 __construct (ElggFileCache $cache, Config $config, Datalist $datalist)
 Constructor. More...
 
 reset ()
 Reset the system cache by deleting the caches. More...
 
 save ($type, $data)
 Saves a system cache. More...
 
 load ($type)
 Retrieve the contents of a system cache. More...
 
 isEnabled ()
 Is system cache enabled. More...
 
 enable ()
 Enables the system disk cache. More...
 
 disable ()
 Disables the system disk cache. More...
 
 loadAll ()
 Loads the system cache during engine boot. More...
 
 init ()
 Initializes the simplecache lastcache variable and creates system cache files when appropriate. More...
 

Detailed Description

Definition at line 18 of file SystemCache.php.

Constructor & Destructor Documentation

Elgg\Cache\SystemCache::__construct ( ElggFileCache  $cache,
Config  $config,
Datalist  $datalist 
)

Constructor.

Parameters
ElggFileCache$cacheElgg disk cache
Config$configElgg config
Datalist$datalistElgg datalist

Definition at line 43 of file SystemCache.php.

Member Function Documentation

Elgg\Cache\SystemCache::disable ( )

Disables the system disk cache.

Uses the 'system_cache_enabled' datalist with a boolean value. Resets the system cache.

Returns
void

Definition at line 121 of file SystemCache.php.

Elgg\Cache\SystemCache::enable ( )

Enables the system disk cache.

Uses the 'system_cache_enabled' datalist with a boolean value. Resets the system cache.

Returns
void

Definition at line 107 of file SystemCache.php.

Elgg\Cache\SystemCache::init ( )

Initializes the simplecache lastcache variable and creates system cache files when appropriate.

private

Definition at line 165 of file SystemCache.php.

Elgg\Cache\SystemCache::isEnabled ( )

Is system cache enabled.

Returns
bool

Definition at line 95 of file SystemCache.php.

Elgg\Cache\SystemCache::load (   $type)

Retrieve the contents of a system cache.

Parameters
string$typeThe type of cache to load
Returns
string

Definition at line 79 of file SystemCache.php.

Elgg\Cache\SystemCache::loadAll ( )

Loads the system cache during engine boot.

See Also
elgg_reset_system_cache() private

Definition at line 133 of file SystemCache.php.

Elgg\Cache\SystemCache::reset ( )

Reset the system cache by deleting the caches.

Returns
void

Definition at line 54 of file SystemCache.php.

Elgg\Cache\SystemCache::save (   $type,
  $data 
)

Saves a system cache.

Parameters
string$typeThe type or identifier of the cache
string$dataThe data to be saved
Returns
bool

Definition at line 65 of file SystemCache.php.


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