Handles a simple LRU key/value map with a maximum number of entries.
More...
|
| __construct ( $maxKeys) |
|
| clear ( $keys=null) |
| Clear one or several cache entries, or all cache entries.
|
|
| get ( $key) |
| Get the value for a key.
|
|
| getAllKeys () |
|
| getWithSetCallback ( $key, callable $callback) |
| Get an item with the given key, producing and setting it if not found.
|
|
| has ( $key) |
| Check if a key exists.
|
|
| set ( $key, $value) |
| Set a key/value pair.
|
|
|
| ping ( $key) |
| Push an entry to the top of the cache.
|
|
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 34 of file MapCacheLRU.php.
◆ __construct()
MapCacheLRU::__construct |
( |
| $maxKeys | ) |
|
- Parameters
-
int | $maxKeys | Maximum number of entries allowed (min 1). |
- Exceptions
-
Exception | When $maxCacheKeys is not an int or not above zero. |
Definition at line 44 of file MapCacheLRU.php.
◆ clear()
MapCacheLRU::clear |
( |
| $keys = null | ) |
|
Clear one or several cache entries, or all cache entries.
- Parameters
-
- Returns
- void
Definition at line 139 of file MapCacheLRU.php.
References $keys, and cache.
◆ get()
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
-
- Returns
- mixed Returns null if the key was not found
Definition at line 92 of file MapCacheLRU.php.
References cache, and ping().
◆ getAllKeys()
MapCacheLRU::getAllKeys |
( |
| ) |
|
◆ getWithSetCallback()
MapCacheLRU::getWithSetCallback |
( |
| $key, |
|
|
callable | $callback ) |
Get an item with the given key, producing and setting it if not found.
If the callback returns false, then nothing is stored.
- Since
- 1.28
- Parameters
-
string | $key | |
callable | $callback | Callback that will produce the value |
- Returns
- mixed The cached value if found or the result of $callback otherwise
Definition at line 120 of file MapCacheLRU.php.
References $value.
◆ has()
Check if a key exists.
- Parameters
-
- Returns
- bool
Definition at line 77 of file MapCacheLRU.php.
References cache.
◆ ping()
MapCacheLRU::ping |
( |
| $key | ) |
|
|
protected |
◆ set()
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
-
- Returns
- void
Definition at line 60 of file MapCacheLRU.php.
References $value, cache, key, and ping().
◆ $cache
array MapCacheLRU::$cache = [] |
|
protected |
◆ $maxCacheKeys
MapCacheLRU::$maxCacheKeys |
|
protected |
The documentation for this class was generated from the following file: