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

__construct()

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

Constructor.

Parameters

ElggFileCache	$cache	Elgg disk cache
Config	$config	Elgg config
Datalist	$datalist	Elgg datalist

Definition at line 43 of file SystemCache.php.

Member Function Documentation

disable()

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.

enable()

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.

init()

Elgg\Cache\SystemCache::init

(

)

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

@access private

Definition at line 165 of file SystemCache.php.

isEnabled()

Elgg\Cache\SystemCache::isEnabled

(

)

Is system cache enabled.

Returns

bool

Definition at line 95 of file SystemCache.php.

load()

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 79 of file SystemCache.php.

loadAll()

Elgg\Cache\SystemCache::loadAll

(

)

Loads the system cache during engine boot.

See also

elgg_reset_system_cache() @access private

Definition at line 133 of file SystemCache.php.

reset()

Elgg\Cache\SystemCache::reset

(

)

Reset the system cache by deleting the caches.

Returns

void

Definition at line 54 of file SystemCache.php.

save()

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 65 of file SystemCache.php.

---

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

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