Elgg\Cache\SystemCache Class Reference

Public Member Functions
	__construct ()
	Constructor. More...
	getFileCache ()
	Returns an object suitable for caching system information. 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...
	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 13 of file SystemCache.php.

Constructor & Destructor Documentation

Elgg\Cache\SystemCache::__construct

(

)

Constructor.

Definition at line 24 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 122 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 106 of file SystemCache.php.

Elgg\Cache\SystemCache::getFileCache

(

)

Returns an object suitable for caching system information.

Returns

A default filestore cache using the dataroot.

Definition at line 37 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::load

(

$type

)

Retrieve the contents of a system cache.

Parameters

string

$type

The type of cache to load

Returns

string

Definition at line 84 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 136 of file SystemCache.php.

Elgg\Cache\SystemCache::reset

(

)

Reset the system cache by deleting the caches.

Returns

void

Definition at line 57 of file SystemCache.php.

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

Saves a system cache.

Parameters

string	$type	The type or identifier of the cache
string	$data	The data to be saved

Returns

bool

Definition at line 68 of file SystemCache.php.

---

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

• engine/classes/Elgg/Cache/SystemCache.php