Add PSR-11 as key store.

Author: byjg

README.md

@@ -95,6 +95,28 @@ You can add a PSR Log compatible to the constructor in order to get Log of the o
 
 See log examples [here](docs/setup-log-handler.md)
 
+## Use a PSR-11 container to retrieve the cache keys
+
+You can use a PSR-11 compatible to retrieve the cache keys. Once is defined, only the keys defined 
+in the PSR-11 will be used to cache. 
+
+```php
+<?php
+$fileCache = new \ByJG\Cache\Psr16\FileSystemCacheEngine()
+$fileCache->withKeysFromContainer(new SomePsr11Implementation());
+```
+
+After the PSR-11 container is defined, when I run:
+
+```php
+$value = $fileCache->get('my-key');
+```
+
+The key `my-key` will be retrieved from the PSR-11 container and
+the value retrieved will be used as the cache key.
+If it does not exist in the PSR-11 container, an exception will be thrown.
+
+
 ## Install
 
 Just type: 

composer.json

@@ -10,7 +10,8 @@
     "php": ">=7.4",
     "psr/cache": "^1.0",
     "psr/log": "^1.1",
-    "psr/simple-cache": "^1.0"
+    "psr/simple-cache": "^1.0",
+    "psr/container": "^2.0"
   },
   "require-dev": {
     "phpunit/phpunit": "5.7.*|7.4.*|^9.5"

src/Psr16/ArrayCacheEngine.php

@@ -34,6 +34,7 @@ public function __construct($logger = null)
      */
     public function has($key)
     {
+        $key = $this->getKeyFromContainer($key);
         if (isset($this->cache[$key])) {
             if (isset($this->cache["$key.ttl"]) && time() >= $this->cache["$key.ttl"]) {
                 $this->delete($key);
@@ -55,6 +56,7 @@ public function has($key)
     public function get($key, $default = null)
     {
         if ($this->has($key)) {
+            $key = $this->getKeyFromContainer($key);
             $this->logger->info("[Array cache] Get '$key' from L1 Cache");
             return $this->cache[$key];
         } else {
@@ -78,6 +80,8 @@ public function get($key, $default = null)
      */
     public function set($key, $value, $ttl = null)
     {
+        $key = $this->getKeyFromContainer($key);
+
         $this->logger->info("[Array cache] Set '$key' in L1 Cache");
 
         $this->cache[$key] = $value;
@@ -101,6 +105,8 @@ public function clear()
      */
     public function delete($key)
     {
+        $key = $this->getKeyFromContainer($key);
+
         unset($this->cache[$key]);
         unset($this->cache["$key.ttl"]);
         return true;

src/Psr16/BaseCacheEngine.php

@@ -6,10 +6,13 @@
 use ByJG\Cache\Exception\InvalidArgumentException;
 use DateInterval;
 use DateTime;
+use Psr\Container\ContainerInterface;
 use Psr\SimpleCache\CacheInterface;
 
 abstract class BaseCacheEngine implements CacheInterface, CacheAvailabilityInterface
 {
+    protected ?ContainerInterface $container;
+
     /**
      * @param $keys
      * @param null $default
@@ -82,4 +85,24 @@ protected function convertToSeconds($ttl)
 
         throw new InvalidArgumentException('Invalid TTL');
     }
+
+
+    protected function getKeyFromContainer($key)
+    {
+        if (empty($this->container)) {
+            return $key;
+        }
+
+        if (!$this->container->has($key)) {
+            throw new InvalidArgumentException("Key '$key' not found in container");
+        }
+
+        return $this->container->get($key);
+    }
+
+    public function withKeysFromContainer(?ContainerInterface $container)
+    {
+        $this->container = $container;
+        return $this;
+    }
 }

src/Psr16/FileSystemCacheEngine.php

@@ -165,6 +165,8 @@ public function isAvailable()
 
     protected function fixKey($key)
     {
+        $key = $this->getKeyFromContainer($key);
+
         return $this->path . '/'
             . $this->prefix
             . '-' . preg_replace("/[\/\\\]/", "#", $key)

src/Psr16/MemcachedEngine.php

@@ -36,6 +36,7 @@ public function __construct($servers = null, $logger = null)
     }
 
     protected function fixKey($key) {
+        $key = $this->getKeyFromContainer($key);
         return "cache-" . $key;
     }
 

src/Psr16/NoCacheEngine.php

@@ -13,6 +13,7 @@ class NoCacheEngine extends BaseCacheEngine implements CacheLockInterface
      */
     public function get($key, $default = null)
     {
+        $key = $this->getKeyFromContainer($key);
         return $default;
     }
 
@@ -24,6 +25,7 @@ public function get($key, $default = null)
      */
     public function set($key, $value, $ttl = 0)
     {
+        $key = $this->getKeyFromContainer($key);
         return true;
     }
 
@@ -33,6 +35,7 @@ public function set($key, $value, $ttl = 0)
      */
     public function delete($key)
     {
+        $key = $this->getKeyFromContainer($key);
         return true;
     }
 
@@ -83,6 +86,7 @@ public function clear()
     */
     public function has($key)
     {
+        $key = $this->getKeyFromContainer($key);
         return false;
     }
 }

src/Psr16/RedisCacheEngine.php

@@ -51,6 +51,7 @@ protected function lazyLoadRedisServer()
     }
 
     protected function fixKey($key) {
+        $key = $this->getKeyFromContainer($key);
         return "cache:$key";
     }
 

src/Psr16/SessionCacheEngine.php

@@ -27,6 +27,7 @@ protected function checkSession()
 
     protected function keyName($key)
     {
+        $key = $this->getKeyFromContainer($key);
         return $this->prefix . '-' . $key;
     }
 

src/Psr16/ShmopCacheEngine.php

@@ -46,6 +46,7 @@ public function __construct($config = [], $logger = null)
 
     protected function getFilenameToken($key)
     {
+        $key = $this->getKeyFromContainer($key);
         return sys_get_temp_dir() . '/shmop-' . sha1($key) . '.cache';
     }