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,121 @@
+<?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\Frontend;
+
+use TYPO3\CMS\Core\Cache\Backend\BackendInterface;
+
+/**
+ * Contract for a Cache (frontend)
+ */
+interface FrontendInterface
+{
+    /**
+     * Pattern an entry identifier must match.
+     */
+    public const PATTERN_ENTRYIDENTIFIER = '/^[a-zA-Z0-9_%\\-&]{1,250}$/';
+
+    /**
+     * Pattern a tag must match.
+     */
+    public const PATTERN_TAG = '/^[a-zA-Z0-9_%\\-&]{1,250}$/';
+
+    /**
+     * Returns this cache's identifier
+     *
+     * @return string The identifier for this cache
+     */
+    public function getIdentifier(): string;
+
+    /**
+     * Returns the backend used by this cache
+     *
+     * @return BackendInterface The backend used by this cache
+     */
+    public function getBackend(): BackendInterface;
+
+    /**
+     * Saves data in the cache.
+     *
+     * @param string $entryIdentifier Something which identifies the data - depends on concrete cache
+     * @param mixed $data The data to cache - also depends on the concrete cache implementation
+     * @param array $tags Tags to associate with this cache entry
+     * @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, mixed $data, array $tags = [], ?int $lifetime = null): void;
+
+    /**
+     * Finds and returns data from the cache.
+     *
+     * @param string $entryIdentifier Something which identifies the cache entry - depends on concrete cache
+     */
+    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 the given cache entry from the cache.
+     *
+     * @param string $entryIdentifier An identifier specifying the cache entry
+     * @return bool TRUE if such an entry exists, FALSE if not
+     */
+    public function remove(string $entryIdentifier): bool;
+
+    /**
+     * Removes all cache entries of this cache.
+     */
+    public function flush(): void;
+
+    /**
+     * Removes all cache entries of this cache which are tagged by the specified tag.
+     *
+     * @param string $tag The tag the entries must have
+     */
+    public function flushByTag(string $tag): void;
+
+    /**
+     * Removes all cache entries of this cache which are tagged by any of the specified tags.
+     *
+     * @param string[] $tags List of tags
+     */
+    public function flushByTags(array $tags): void;
+
+    /**
+     * Does garbage collection
+     */
+    public function collectGarbage(): void;
+
+    /**
+     * Checks the validity of an entry identifier. Returns TRUE if it's valid.
+     *
+     * @param string $identifier An identifier to be checked for validity
+     */
+    public function isValidEntryIdentifier(string $identifier): bool;
+
+    /**
+     * Checks the validity of a tag. Returns TRUE if it's valid.
+     *
+     * @param string $tag A tag to be checked for validity
+     */
+    public function isValidTag(string $tag): bool;
+}