Elgg\Cache\EntityCache Class Reference

Volatile cache for entities. More...

Public Member Functions
	__construct (ElggSession $session, MetadataCache $metadata_cache)
	Constructor. More...
	get ($guid)
	Retrieve a entity from the cache. More...
	getByUsername ($username)
	Returns cached user entity by username. More...
	set (ElggEntity $entity)
	Cache an entity. More...
	remove ($guid)
	Invalidate this class's entry in the cache. More...
	clear ()
	Clear the entity cache. More...
	disableCachingForEntity ($guid)
	Remove this entity from the entity cache and make sure it is not re-added. More...
	enableCachingForEntity ($guid)
	Allow this entity to be stored in the entity cache. More...

Public Attributes
const	MAX_SIZE = 256

Detailed Description

Volatile cache for entities.

@access private

Definition at line 12 of file EntityCache.php.

Constructor & Destructor Documentation

__construct()

Elgg\Cache\EntityCache::__construct	(	ElggSession	$session,
		MetadataCache	$metadata_cache
	)

Constructor.

Parameters

ElggSession	$session	Session
MetadataCache	$metadata_cache	MD cache

Definition at line 48 of file EntityCache.php.

Member Function Documentation

clear()

Elgg\Cache\EntityCache::clear

(

)

Clear the entity cache.

Returns

void

Definition at line 157 of file EntityCache.php.

disableCachingForEntity()

Elgg\Cache\EntityCache::disableCachingForEntity

(

$guid

)

Remove this entity from the entity cache and make sure it is not re-added.

Parameters

int

$guid

The entity guid

Returns

void

Definition at line 172 of file EntityCache.php.

enableCachingForEntity()

Elgg\Cache\EntityCache::enableCachingForEntity

(

$guid

)

Allow this entity to be stored in the entity cache.

Parameters

int

$guid

The entity guid

Returns

void

Definition at line 183 of file EntityCache.php.

get()

Elgg\Cache\EntityCache::get

(

$guid

)

Retrieve a entity from the cache.

Parameters

int

$guid

The GUID

Returns

\ElggEntity|false false if entity not cached, or not fully loaded

Definition at line 62 of file EntityCache.php.

getByUsername()

Elgg\Cache\EntityCache::getByUsername

(

$username

)

Returns cached user entity by username.

Parameters

string

$username

Username

Returns

\ElggUser|false

Definition at line 80 of file EntityCache.php.

remove()

Elgg\Cache\EntityCache::remove

(

$guid

)

Invalidate this class's entry in the cache.

Parameters

int

$guid

The entity guid

Returns

void

Definition at line 128 of file EntityCache.php.

set()

Elgg\Cache\EntityCache::set

(

ElggEntity

$entity

)

Cache an entity.

Parameters

ElggEntity

$entity

Entity to cache

Returns

void

Definition at line 93 of file EntityCache.php.

Member Data Documentation

MAX_SIZE

const Elgg\Cache\EntityCache::MAX_SIZE = 256

Definition at line 15 of file EntityCache.php.

---

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

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