Least Recently Used Cache.
More...
Least Recently Used Cache.
A fixed sized cache that removes the element used last when it reaches its size limit.
Based on https://github.com/cash/LRUCache
Definition at line 17 of file LRUCache.php.
Elgg\Cache\LRUCache::__construct |
( |
int |
$size | ) |
|
Create a LRU Cache.
- Parameters
-
int | $size | The size of the cache |
- Exceptions
-
Definition at line 37 of file LRUCache.php.
Elgg\Cache\LRUCache::clear |
( |
| ) |
|
Elgg\Cache\LRUCache::containsKey |
( |
|
$key | ) |
|
Does the cache contain an element with this key.
- Parameters
-
- Returns
- boolean
Definition at line 97 of file LRUCache.php.
Elgg\Cache\LRUCache::get |
( |
|
$key, |
|
|
|
$default = null |
|
) |
| |
Get the value cached with this key.
- Parameters
-
int | string | $key | The key. Strings that are ints are cast to ints. |
mixed | $default | The value to be returned if key not found. (Optional) |
- Returns
- mixed
Definition at line 51 of file LRUCache.php.
Elgg\Cache\LRUCache::offsetExists |
( |
|
$key | ) |
|
Does key exist?
- See also
- ::offsetExists()
- Parameters
-
int | string | $key | A key to check for. |
- Returns
- boolean
Definition at line 187 of file LRUCache.php.
Elgg\Cache\LRUCache::offsetGet |
( |
|
$key | ) |
|
Get the value for specified key.
- See also
- ::offsetGet()
- Parameters
-
int | string | $key | The key to retrieve. |
- Returns
- mixed
Definition at line 161 of file LRUCache.php.
Elgg\Cache\LRUCache::offsetSet |
( |
|
$key, |
|
|
|
$value |
|
) |
| |
Assigns a value for the specified key.
- See also
- ::offsetSet()
- Parameters
-
int | string | $key | The key to assign the value to. |
mixed | $value | The value to set. |
- Returns
- void
Definition at line 148 of file LRUCache.php.
Elgg\Cache\LRUCache::offsetUnset |
( |
|
$key | ) |
|
Unsets a key.
- See also
- ::offsetUnset()
- Parameters
-
int | string | $key | The key to unset. |
- Returns
- void
Definition at line 174 of file LRUCache.php.
Elgg\Cache\LRUCache::recordAccess |
( |
|
$key | ) |
|
|
protected |
Moves the element from current position to end of array.
- Parameters
-
- Returns
- void
Definition at line 132 of file LRUCache.php.
Elgg\Cache\LRUCache::remove |
( |
|
$key | ) |
|
Remove the element with this key.
- Parameters
-
- Returns
- mixed Value or null if not set
Definition at line 107 of file LRUCache.php.
Elgg\Cache\LRUCache::set |
( |
|
$key, |
|
|
|
$value |
|
) |
| |
Add something to the cache.
- Parameters
-
int | string | $key | The key. Strings that are ints are cast to ints. |
mixed | $value | The value to cache |
- Returns
- void
Definition at line 68 of file LRUCache.php.
Elgg\Cache\LRUCache::size |
( |
| ) |
|
Get the number of elements in the cache.
- Returns
- int
Definition at line 87 of file LRUCache.php.
Elgg\Cache\LRUCache::$data = [] |
|
protected |
Elgg\Cache\LRUCache::$maximumSize |
|
protected |
The documentation for this class was generated from the following file: