aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/StudipCache.class.php
diff options
context:
space:
mode:
authorPhilipp Schüttlöffel <schuettloeffel@zqs.uni-hannover.de>2024-09-24 10:53:31 +0200
committerPhilipp Schüttlöffel <schuettloeffel@zqs.uni-hannover.de>2024-09-24 10:53:31 +0200
commit4459dd7917f4d1c34f40bb68f0e991e9c3d53e4c (patch)
tree5c07151ae61276d334e88f6309c30d439a85c12e /lib/classes/StudipCache.class.php
parentda0022e5c1abbf9825ae76debaabdff7e8623bb4 (diff)
parent97a188592c679890a25c37ab78463add76a52ff7 (diff)
Merge branch 'main' into issue-3911issue-3911
Diffstat (limited to 'lib/classes/StudipCache.class.php')
-rw-r--r--lib/classes/StudipCache.class.php94
1 files changed, 0 insertions, 94 deletions
diff --git a/lib/classes/StudipCache.class.php b/lib/classes/StudipCache.class.php
deleted file mode 100644
index ba929f9..0000000
--- a/lib/classes/StudipCache.class.php
+++ /dev/null
@@ -1,94 +0,0 @@
-<?php
-/**
- * An interface which has to be implemented by instances returned from
- * StudipCacheFactory#getCache
- *
- * @package studip
- * @subpackage lib
- *
- * @author Marco Diedrich (mdiedric@uos)
- * @author Marcus Lunzenauer (mlunzena@uos.de)
- * @copyright (c) Authors
- * @since 1.6
- * @license GPL2 or any later version
- */
-
-interface StudipCache
-{
- const DEFAULT_EXPIRATION = 12 * 60 * 60; // 12 hours
-
- /**
- * Expire item from the cache.
- *
- * Example:
- *
- * # expires foo
- * $cache->expire('foo');
- *
- * @param string $arg a single key
- */
- public function expire($arg);
-
- /**1
- * Expire all items from the cache.
- */
- public function flush();
-
- /**
- * Retrieve item from the server.
- *
- * Example:
- *
- * # reads foo
- * $foo = $cache->reads('foo');
- *
- * @param string $arg a single key
- *
- * @return mixed the previously stored data if an item with such a key
- * exists on the server or FALSE on failure.
- */
- public function read($arg);
-
- /**
- * Store data at the server.
- *
- * @param string $name the item's key.
- * @param mixed $content the item's content (will be serialized if necessary).
- * @param int $expires the item's expiry time in seconds. Optional, defaults to 12h.
- *
- * @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;
-}