Elgg\Cache\CacheCollection Class Reference

A collection of composite caches. More...

Inheritance diagram for Elgg\Cache\CacheCollection:

Public Member Functions
	__construct (Config $config)
	Constructor. More...
	__get ($name)
	{} More...
	get ($namespace)
	Returns an instance of composite cache, or creates one. More...
	clear ()
	Clear all persistent caches. More...
	invalidate ()
	Invalidate all caches. More...
	purge ()
	Purge all caches. More...
	disable ()
	Disable all persistent caches. More...
	enable ()
	Enable all persistent caches. More...

Protected Member Functions
	create ($namespace)
	Create a new cache under a namespace. More...

Protected Attributes
	$caches = []
	$config

Detailed Description

A collection of composite caches.

Definition at line 10 of file CacheCollection.php.

Constructor & Destructor Documentation

Elgg\Cache\CacheCollection::__construct

(

Config

$config

)

Constructor.

Parameters

Config

$config

Elgg config

Definition at line 27 of file CacheCollection.php.

Member Function Documentation

Elgg\Cache\CacheCollection::__get

(

$name

)

{}

Definition at line 34 of file CacheCollection.php.

Elgg\Cache\CacheCollection::clear

(

)

Clear all persistent caches.

Returns

void

Definition at line 68 of file CacheCollection.php.

Elgg\Cache\CacheCollection::create (   $namespace )

abstractprotected

Create a new cache under a namespace.

Parameters

string

$namespace

Namespace

Returns

CompositeCache

Elgg\Cache\CacheCollection::disable

(

)

Disable all persistent caches.

Returns

void

Definition at line 101 of file CacheCollection.php.

Elgg\Cache\CacheCollection::enable

(

)

Enable all persistent caches.

Returns

void

Definition at line 112 of file CacheCollection.php.

Elgg\Cache\CacheCollection::get

(

$namespace

)

Returns an instance of composite cache, or creates one.

Parameters

string

$namespace

Cache namespace

Returns

CompositeCache

Definition at line 55 of file CacheCollection.php.

Elgg\Cache\CacheCollection::invalidate

(

)

Invalidate all caches.

Returns

void

Definition at line 79 of file CacheCollection.php.

Elgg\Cache\CacheCollection::purge

(

)

Purge all caches.

Returns

void

Definition at line 90 of file CacheCollection.php.

Member Data Documentation

Elgg\Cache\CacheCollection::$caches = []

protected

Definition at line 15 of file CacheCollection.php.

Elgg\Cache\CacheCollection::$config

protected

Definition at line 20 of file CacheCollection.php.

---

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

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