MapCacheLRU Class Reference

Handles a simple LRU key/value map with a maximum number of entries. More...

Collaboration diagram for MapCacheLRU:

List of all members.

Public Member Functions
	__construct ($maxKeys)
	clear ($keys=null)
	Clear one or several cache entries, or all cache entries.
	get ($key)
	Get the value for a key.
	has ($key)
	Check if a key exists.
	set ($key, $value)
	Set a key/value pair.
Protected Member Functions
	ping ($key)
	Push an entry to the top of the cache.
Protected Attributes
array	$cache = array()
	*
	$maxCacheKeys

---

Detailed Description

Handles a simple LRU key/value map with a maximum number of entries.

Use ProcessCacheLRU if hierarchical purging is needed or objects can become stale

See also:

ProcessCacheLRU

Since:

1.23

Definition at line 33 of file MapCacheLRU.php.

---

Constructor & Destructor Documentation

MapCacheLRU::__construct

(

$

maxKeys

)

Parameters:

int

$maxKeys

Maximum number of entries allowed (min 1).

Exceptions:

MWException

When $maxCacheKeys is not an int or =< 0.

Definition at line 42 of file MapCacheLRU.php.

---

Member Function Documentation

MapCacheLRU::clear

(

$

keys = null

)

Clear one or several cache entries, or all cache entries.

Parameters:

string | array

$keys

Returns:

void

Definition at line 102 of file MapCacheLRU.php.

MapCacheLRU::get

(

$

key

)

Get the value for a key.

This returns null if the key is not set. If the item is already set, it will be pushed to the top of the cache.

Parameters:

string

$key

Returns:

mixed

Definition at line 87 of file MapCacheLRU.php.

MapCacheLRU::has

(

$

key

)

Check if a key exists.

Parameters:

string

$key

Returns:

bool

Definition at line 75 of file MapCacheLRU.php.

MapCacheLRU::ping

(

$

key

)

[protected]

Push an entry to the top of the cache.

Parameters:

string

$key

Definition at line 117 of file MapCacheLRU.php.

MapCacheLRU::set	(	$	key,
		$	value
	)

Set a key/value pair.

This will prune the cache if it gets too large based on LRU. If the item is already set, it will be pushed to the top of the cache.

Parameters:

string	$key
mixed	$value

Returns:

void

Definition at line 58 of file MapCacheLRU.php.

---

Member Data Documentation

array MapCacheLRU::$cache = array() [protected]

*

Definition at line 34 of file MapCacheLRU.php.

MapCacheLRU::$maxCacheKeys [protected]

Definition at line 36 of file MapCacheLRU.php.

---

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

• includes/cache/MapCacheLRU.php