StudipMemoryCache Class Reference
Inheritance diagram for StudipMemoryCache:
Public Member Functions | |
| expire ($key) | |
| flush () | |
| read ($key) | |
| write ($name, $content, $expires=self::DEFAULT_EXPIRATION) | |
| getStats () | |
Static Public Member Functions | |
| static | getDisplayName () |
| static | getConfig () |
Protected Attributes | |
| $memory_cache = [] | |
Additional Inherited Members | |
 Data Fields inherited from StudipCache | |
| const | DEFAULT_EXPIRATION = 12 * 60 * 60 |
Detailed Description
The php memory implementation of the StudipCache interface.
- Since
- Stud.IP 5.0
Member Function Documentation
◆ expire()
| expire | ( | $key | ) |
◆ flush()
| flush | ( | ) |
Expire all items from the cache.
Implements StudipCache.
◆ getConfig()
|
static |
Return the Vue component name and props that handle configuration. The associative array is of the form [ 'component' => <Vue component="" name>="">, 'props' => <Properties for="" component>=""> ]
- Returns
- array
Implements StudipCache.
◆ getDisplayName()
|
static |
- Returns
- string A translateable display name for this cache class.
Implements StudipCache.
◆ getStats()
| getStats | ( | ) |
Get some statistics from cache, like number of entries, hit rate or whatever the underlying cache provides. Results are returned in form of an array like "[ [ 'name' => <displayable name>=""> 'value' =>
] ]"
- Returns
- array
Implements StudipCache.
◆ read()
| read | ( | $key | ) |
Reads just a single key from the cache.
- Parameters
-
string the key
- Returns
- mixed the corresponding value
Implements StudipCache.
◆ write()
| write | ( | $name, | |
| $content, | |||
$expires = self::DEFAULT_EXPIRATION |
|||
| ) |
Store data at the server.
- Parameters
-
string the item's key. mixed the item's content (will be serialized if necessary). int the item's expiry time in seconds. Defaults to 12h.
- Returns
- mixed returns TRUE on success or FALSE on failure.
Implements StudipCache.
Field Documentation
◆ $memory_cache
|
protected |
The documentation for this class was generated from the following file:
- lib/classes/StudipMemoryCache.class.php
