aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/StudipCache.class.php
diff options
context:
space:
mode:
authorJan-Hendrik Willms <tleilax+studip@gmail.com>2023-10-02 09:19:55 +0000
committerJan-Hendrik Willms <tleilax+studip@gmail.com>2023-10-02 09:19:55 +0000
commitfe64b827e2e503085c6f596eeed08d6ece36624b (patch)
tree4404ebfc07eec72f1bb46bd19f8244ecc0b7b48a /lib/classes/StudipCache.class.php
parent8554b74bb2cc62bda4bdeb8ba6b081fde5f619ce (diff)
fixes #3029
Closes #3029 Merge request studip/studip!2036
Diffstat (limited to 'lib/classes/StudipCache.class.php')
-rw-r--r--lib/classes/StudipCache.class.php32
1 files changed, 32 insertions, 0 deletions
diff --git a/lib/classes/StudipCache.class.php b/lib/classes/StudipCache.class.php
index 79e80e3..ba929f9 100644
--- a/lib/classes/StudipCache.class.php
+++ b/lib/classes/StudipCache.class.php
@@ -59,4 +59,36 @@ interface StudipCache
* @return bool returns TRUE on success or FALSE on failure.
*/
public function write($name, $content, $expires = self::DEFAULT_EXPIRATION);
+
+ /**
+ * @return string A translateable display name for this cache class.
+ */
+ public static function getDisplayName(): string;
+
+ /**
+ * 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' => <value of the current stat>
+ * ]
+ * ]"
+ *
+ * @return array
+ */
+ public function getStats(): array;
+
+ /**
+ * 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>
+ * ]
+ *
+ * @return array
+ */
+ public static function getConfig(): array;
}