Inheritance diagram for Elgg\Cache\Pool:
Public Member Functions | |
| get ($key, callable $callback) | |
| Fetches a value from the cache, calculating on miss via $callback. More... | |
| invalidate ($key) | |
| Forcefully invalidates the value associated with the given key. More... | |
| put ($key, $value) | |
| Prime the cache to a specific value. More... | |
Detailed Description
Member Function Documentation
◆ get()
| Elgg\Cache\Pool::get | ( | $key, | |
| callable | $callback | ||
| ) |
Fetches a value from the cache, calculating on miss via $callback.
- Parameters
-
string | int $key A plain string ID for the cache entry callable $callback Logic for calculating the cache entry on miss
- Returns
- mixed The cache value
Implemented in Elgg\Cache\StashPool, Elgg\Cache\NullPool, and Elgg\Cache\MemoryPool.
◆ invalidate()
| Elgg\Cache\Pool::invalidate | ( | $key | ) |
Forcefully invalidates the value associated with the given key.
Implementations must:
- Immediately consider the value stale
- Recalculate the value at the next opportunity
- Parameters
-
string | int $key A plain string ID for the cache entry to invalidate.
- Returns
- void
Implemented in Elgg\Cache\StashPool, Elgg\Cache\NullPool, and Elgg\Cache\MemoryPool.
◆ put()
| Elgg\Cache\Pool::put | ( | $key, | |
| $value | |||
| ) |
Prime the cache to a specific value.
This is useful when the value was calculated by some out-of-band means. For example, when a list of rows is fetched from the database, you can prime the cache for each individual result.
- Parameters
-
string | int $key A plain string ID for the cache entry mixed $value The cache value
- Returns
- void
Implemented in Elgg\Cache\StashPool, Elgg\Cache\NullPool, and Elgg\Cache\MemoryPool.
The documentation for this interface was generated from the following file:
- engine/classes/Elgg/Cache/Pool.php
