TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:09 +02:00
commit af8cc155b5
6818 changed files with 642608 additions and 0 deletions
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Core\Cache\Backend;
+
+use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
+
+/**
+ * A contract for a Cache Backend
+ */
+interface BackendInterface
+{
+    /**
+     * Sets a reference to the cache frontend which uses this backend
+     *
+     * @param FrontendInterface $cache The frontend for this backend
+     */
+    public function setCache(FrontendInterface $cache): void;
+
+    /**
+     * Saves data in the cache.
+     *
+     * @param string $entryIdentifier An identifier for this specific cache entry
+     * @param string $data The data to be stored
+     * @param array $tags Tags to associate with this cache entry. If the backend does not support tags, this option can be ignored.
+     * @param int|null $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
+     */
+    public function set(string $entryIdentifier, string $data, array $tags = [], ?int $lifetime = null): void;
+
+    /**
+     * Loads data from the cache.
+     *
+     * @param string $entryIdentifier An identifier which describes the cache entry to load
+     * @return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded
+     */
+    public function get(string $entryIdentifier): mixed;
+
+    /**
+     * Checks if a cache entry with the specified identifier exists.
+     *
+     * @param string $entryIdentifier An identifier specifying the cache entry
+     * @return bool TRUE if such an entry exists, FALSE if not
+     */
+    public function has(string $entryIdentifier): bool;
+
+    /**
+     * Removes all cache entries matching the specified identifier.
+     * Usually this only affects one entry but if - for what reason ever -
+     * old entries for the identifier still exist, they are removed as well.
+     *
+     * @param string $entryIdentifier Specifies the cache entry to remove
+     * @return bool TRUE if (at least) an entry could be removed or FALSE if no entry was found
+     */
+    public function remove(string $entryIdentifier): bool;
+
+    /**
+     * Removes all cache entries of this cache.
+     */
+    public function flush(): void;
+
+    /**
+     * Does garbage collection
+     */
+    public function collectGarbage(): void;
+}