MessageGroupWANCache Class Reference

Wrapper around WANObjectCache providing a simpler interface for MessageGroups to use the cache. More...

Public Member Functions
	__construct (WANObjectCache $cache)
	getValue ( $recache=false)
	Fetches value from cache for a message group.
	setValue ( $cacheData)
	Sets value in the cache for the message group.
	touchKey ()
	delete ()
	Deletes the cached value.
	configure (array $config)
	Configure the message group.

Protected Member Functions
	checkConfig ()
	Check to see if the instance is configured properly.

Protected Attributes
	$cache
	$cacheKey
	$cacheVersion
	$regenerator
	$lockTSE
	$checkKeys
	$touchedCallback
	$ttl

Detailed Description

Wrapper around WANObjectCache providing a simpler interface for MessageGroups to use the cache.

Since

2019.05

Definition at line 15 of file MessageGroupWANCache.php.

Constructor & Destructor Documentation

__construct()

MessageGroupWANCache::__construct

(

WANObjectCache

$cache

)

Definition at line 64 of file MessageGroupWANCache.php.

Member Function Documentation

checkConfig()

MessageGroupWANCache::checkConfig ( )

protected

Check to see if the instance is configured properly.

Definition at line 153 of file MessageGroupWANCache.php.

configure()

MessageGroupWANCache::configure

(

array

$config

)

Configure the message group.

This must be called before making a call to any other method.

Parameters

array

$config

Definition at line 129 of file MessageGroupWANCache.php.

delete()

MessageGroupWANCache::delete

(

)

Deletes the cached value.

Definition at line 118 of file MessageGroupWANCache.php.

getValue()

MessageGroupWANCache::getValue

(

$recache = false

)

Fetches value from cache for a message group.

Parameters

string | false

$recache

Either "recache" or false

Returns

mixed

Definition at line 74 of file MessageGroupWANCache.php.

setValue()

MessageGroupWANCache::setValue

(

$cacheData

)

Sets value in the cache for the message group.

Parameters

mixed

$cacheData

Definition at line 105 of file MessageGroupWANCache.php.

touchKey()

MessageGroupWANCache::touchKey

(

)

Definition at line 110 of file MessageGroupWANCache.php.

Member Data Documentation

$cache

MessageGroupWANCache::$cache

protected

Definition at line 18 of file MessageGroupWANCache.php.

$cacheKey

MessageGroupWANCache::$cacheKey

protected

Definition at line 24 of file MessageGroupWANCache.php.

$cacheVersion

MessageGroupWANCache::$cacheVersion

protected

Definition at line 30 of file MessageGroupWANCache.php.

$checkKeys

MessageGroupWANCache::$checkKeys

protected

Definition at line 46 of file MessageGroupWANCache.php.

$lockTSE

MessageGroupWANCache::$lockTSE

protected

Definition at line 41 of file MessageGroupWANCache.php.

$regenerator

MessageGroupWANCache::$regenerator

protected

Definition at line 36 of file MessageGroupWANCache.php.

$touchedCallback

MessageGroupWANCache::$touchedCallback

protected

Definition at line 51 of file MessageGroupWANCache.php.

$ttl

MessageGroupWANCache::$ttl

protected

Definition at line 56 of file MessageGroupWANCache.php.

---

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

• utils/MessageGroupWANCache.php