fixes #3029

Closes #3029

Merge request !2036

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;
 }

lib/classes/StudipCacheProxy.php

@@ -99,4 +99,19 @@ class StudipCacheProxy implements StudipCache
 
         return $this->actual_cache->write($key, $content, $expires);
     }
+
+    public static function getDisplayName(): string
+    {
+        return static::class;
+    }
+
+    public function getStats(): array
+    {
+        return $this->actual_cache->getStats();
+    }
+
+    public static function getConfig(): array
+    {
+        return [];
+    }
 }

lib/classes/StudipCacheWrapper.php

@@ -67,4 +67,19 @@ class StudipCacheWrapper implements StudipCache
             return false;
         }
     }
+
+    public static function getDisplayName(): string
+    {
+        return static::class;
+    }
+
+    public function getStats(): array
+    {
+        return $this->actual_cache->getStats();
+    }
+
+    public static function getConfig(): array
+    {
+        return [];
+    }
 }

lib/classes/StudipDbCache.class.php

@@ -7,7 +7,7 @@
  *
  * @author    Elmar Ludwig <elmar.ludwig@uos.de>
  */
-class StudipDbCache implements StudipSystemCache
+class StudipDbCache implements StudipCache
 {
 
     /**

lib/classes/StudipFileCache.class.php

@@ -31,7 +31,7 @@
  * @author    André Noack <noack@data-quest.de>
  * @version   2
  */
-class StudipFileCache implements StudipSystemCache
+class StudipFileCache implements StudipCache
 {
     use StudipCacheKeyTrait;
 
@@ -236,8 +236,6 @@ class StudipFileCache implements StudipSystemCache
     /**
      * Return statistics.
      *
-     * @StudipSystemCache::getStats()
-     *
      * @return array|array[]
      */
     public function getStats(): array
@@ -253,8 +251,6 @@ class StudipFileCache implements StudipSystemCache
     /**
      * Return the Vue component name and props that handle configuration.
      *
-     * @see StudipSystemCache::getConfig()
-     *
      * @return array
      */
     public static function getConfig(): array

lib/classes/StudipMemcachedCache.php

@@ -21,7 +21,7 @@
  * @since   5.0
  */
 
-class StudipMemcachedCache implements StudipSystemCache
+class StudipMemcachedCache implements StudipCache
 {
     use StudipCacheKeyTrait;
 

lib/classes/StudipMemoryCache.class.php

@@ -66,4 +66,19 @@ class StudipMemoryCache implements StudipCache
 
         return true;
     }
+
+    public static function getDisplayName(): string
+    {
+        return 'Memory cache';
+    }
+
+    public function getStats(): array
+    {
+        return [];
+    }
+
+    public static function getConfig(): array
+    {
+        return [];
+    }
 }

lib/classes/StudipRedisCache.class.php

@@ -8,7 +8,7 @@
  * @subpackage  cache
  * @since       Stud.IP 5.0
  */
-class StudipRedisCache implements StudipSystemCache
+class StudipRedisCache implements StudipCache
 {
     use StudipCacheKeyTrait;
 

lib/classes/StudipSystemCache.class.php

-<?php
-/**
- * An interface which has to be implemented by caches available for administration
- * via Stud.IP GUI
- *
- * @package    studip
- * @subpackage lib
- *
- * @author     Thomas Hackl <studip@thomas-hackl.name>
- * @copyright  2021 Stud.IP Core-Group
- * @since      Stud.IP 5.0
- * @license    GPL2 or any later version
- */
-
-interface StudipSystemCache extends StudipCache
-{
-
-    /**
-     * @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;
-}