[Cache] Enable namespace-based invalidation by prefixing keys with backend-native namespace separators

nicolas-grekas · nicolas-grekas · commit 5d68a57d6691 · 2025-03-13T16:25:07.000+01:00
diff --git a/NamespacedPoolInterface.php b/NamespacedPoolInterface.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Contracts\Cache;
+
+use Psr\Cache\InvalidArgumentException;
+
+/**
+ * Enables namespace-based invalidation by prefixing keys with backend-native namespace separators.
+ *
+ * Note that calling `withSubNamespace()` MUST NOT mutate the pool, but return a new instance instead.
+ *
+ * When tags are used, they MUST ignore sub-namespaces.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+interface NamespacedPoolInterface
+{
+    /**
+     * @throws InvalidArgumentException If the namespace contains characters found in ItemInterface's RESERVED_CHARACTERS
+     */
+    public function withSubNamespace(string $namespace): static;
+}
