symfony · fabpot · Oct 10, 2018 · Oct 3, 2018
diff --git a/src/Symfony/Component/Cache/Adapter/AbstractAdapter.php b/src/Symfony/Component/Cache/Adapter/AbstractAdapter.php
@@ -19,7 +19,7 @@
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
 use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Cache\Traits\AbstractTrait;
-use Symfony\Component\Cache\Traits\GetTrait;
+use Symfony\Component\Cache\Traits\ContractsTrait;
 use Symfony\Contracts\Cache\CacheInterface;
 
 /**
@@ -28,7 +28,7 @@
 abstract class AbstractAdapter implements AdapterInterface, CacheInterface, LoggerAwareInterface, ResettableInterface
 {
     use AbstractTrait;
-    use GetTrait;
+    use ContractsTrait;
 
     private static $apcuSupported;
     private static $phpFilesSupported;

diff --git a/src/Symfony/Component/Cache/Adapter/ArrayAdapter.php b/src/Symfony/Component/Cache/Adapter/ArrayAdapter.php
@@ -151,4 +151,12 @@ public function commit()
     {
         return true;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete(string $key): bool
+    {
+        return $this->deleteItem($key);
+    }
 }
diff --git a/src/Symfony/Component/Cache/Adapter/ChainAdapter.php b/src/Symfony/Component/Cache/Adapter/ChainAdapter.php
@@ -17,7 +17,7 @@
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
 use Symfony\Component\Cache\PruneableInterface;
 use Symfony\Component\Cache\ResettableInterface;
-use Symfony\Component\Cache\Traits\GetTrait;
+use Symfony\Component\Cache\Traits\ContractsTrait;
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Service\ResetInterface;
 
@@ -31,7 +31,7 @@
  */
 class ChainAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
 {
-    use GetTrait;
+    use ContractsTrait;
 
     private $adapters = array();
     private $adapterCount;

diff --git a/src/Symfony/Component/Cache/Adapter/NullAdapter.php b/src/Symfony/Component/Cache/Adapter/NullAdapter.php
@@ -119,6 +119,14 @@ public function commit()
         return false;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function delete(string $key): bool
+    {
+        return $this->deleteItem($key);
+    }
+
     private function generateItems(array $keys)
     {
         $f = $this->createCacheItem;

diff --git a/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php b/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php
@@ -17,7 +17,7 @@
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
 use Symfony\Component\Cache\PruneableInterface;
 use Symfony\Component\Cache\ResettableInterface;
-use Symfony\Component\Cache\Traits\GetTrait;
+use Symfony\Component\Cache\Traits\ContractsTrait;
 use Symfony\Component\Cache\Traits\PhpArrayTrait;
 use Symfony\Contracts\Cache\CacheInterface;
 
@@ -31,7 +31,7 @@
 class PhpArrayAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
 {
     use PhpArrayTrait;
-    use GetTrait;
+    use ContractsTrait;
 
     private $createCacheItem;
 

diff --git a/src/Symfony/Component/Cache/Adapter/ProxyAdapter.php b/src/Symfony/Component/Cache/Adapter/ProxyAdapter.php
@@ -16,7 +16,7 @@
 use Symfony\Component\Cache\CacheItem;
 use Symfony\Component\Cache\PruneableInterface;
 use Symfony\Component\Cache\ResettableInterface;
-use Symfony\Component\Cache\Traits\GetTrait;
+use Symfony\Component\Cache\Traits\ContractsTrait;
 use Symfony\Component\Cache\Traits\ProxyTrait;
 use Symfony\Contracts\Cache\CacheInterface;
 
@@ -26,7 +26,7 @@
 class ProxyAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
 {
     use ProxyTrait;
-    use GetTrait;
+    use ContractsTrait;
 
     private $namespace;
     private $namespaceLen;

diff --git a/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php b/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php
@@ -16,7 +16,7 @@
 use Symfony\Component\Cache\CacheItem;
 use Symfony\Component\Cache\PruneableInterface;
 use Symfony\Component\Cache\ResettableInterface;
-use Symfony\Component\Cache\Traits\GetTrait;
+use Symfony\Component\Cache\Traits\ContractsTrait;
 use Symfony\Component\Cache\Traits\ProxyTrait;
 use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
@@ -28,7 +28,7 @@ class TagAwareAdapter implements TagAwareAdapterInterface, TagAwareCacheInterfac
     const TAGS_PREFIX = "\0tags\0";
 
     use ProxyTrait;
-    use GetTrait;
+    use ContractsTrait;
 
     private $deferred = array();
     private $createCacheItem;

diff --git a/src/Symfony/Component/Cache/Adapter/TraceableAdapter.php b/src/Symfony/Component/Cache/Adapter/TraceableAdapter.php
@@ -237,6 +237,19 @@ public function reset()
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function delete(string $key): bool
+    {
+        $event = $this->start(__FUNCTION__);
+        try {
+            return $event->result[$key] = $this->pool->deleteItem($key);
+        } finally {
+            $event->end = microtime(true);
+        }
+    }
+
     public function getCalls()
     {
         return $this->calls;

diff --git a/...mfony/Component/Cache/Traits/GetTrait.php → ...Component/Cache/Traits/ContractsTrait.php b/...mfony/Component/Cache/Traits/GetTrait.php → ...Component/Cache/Traits/ContractsTrait.php
@@ -16,15 +16,20 @@
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
 use Symfony\Component\Cache\LockRegistry;
 use Symfony\Contracts\Cache\CacheInterface;
+use Symfony\Contracts\Cache\CacheTrait;
 use Symfony\Contracts\Cache\ItemInterface;
 
 /**
  * @author Nicolas Grekas <p@tchwork.com>
  *
  * @internal
  */
-trait GetTrait
+trait ContractsTrait
 {
+    use CacheTrait {
+        doGet as private contractsGet;
+    }
+
     private $callbackWrapper = array(LockRegistry::class, 'compute');
 
     /**
@@ -42,47 +47,12 @@ public function setCallbackWrapper(callable $callbackWrapper): callable
         return $previousWrapper;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function get(string $key, callable $callback, float $beta = null)
-    {
-        return $this->doGet($this, $key, $callback, $beta);
-    }
-
     private function doGet(AdapterInterface $pool, string $key, callable $callback, ?float $beta)
     {
         if (0 > $beta = $beta ?? 1.0) {
             throw new InvalidArgumentException(sprintf('Argument "$beta" provided to "%s::get()" must be a positive number, %f given.', \get_class($this), $beta));
         }
 
-        $t = 0;
-        $item = $pool->getItem($key);
-        $recompute = !$item->isHit() || INF === $beta;
-
-        if (0 < $beta) {
-            if ($recompute) {
-                $t = microtime(true);
-            } else {
-                $metadata = $item->getMetadata();
-                $expiry = $metadata[ItemInterface::METADATA_EXPIRY] ?? false;
-                $ctime = $metadata[ItemInterface::METADATA_CTIME] ?? false;
-
-                if ($ctime && $expiry) {
-                    $t = microtime(true);
-                    $recompute = $expiry <= $t - $ctime / 1000 * $beta * log(random_int(1, PHP_INT_MAX) / PHP_INT_MAX);
-                }
-            }
-            if ($recompute) {
-                // force applying defaultLifetime to expiry
-                $item->expiresAt(null);
-            }
-        }
-
-        if (!$recompute) {
-            return $item->get();
-        }
-
         static $save;
 
         $save = $save ?? \Closure::bind(
@@ -99,16 +69,19 @@ function (AdapterInterface $pool, ItemInterface $item, $value, float $startTime)
             CacheItem::class
         );
 
-        // don't wrap nor save recursive calls
-        if (null === $callbackWrapper = $this->callbackWrapper) {
-            return $callback($item);
-        }
-        $this->callbackWrapper = null;
+        return $this->contractsGet($pool, $key, function (CacheItem $item) use ($pool, $callback, $save) {
+            // don't wrap nor save recursive calls
+            if (null === $callbackWrapper = $this->callbackWrapper) {
+                return $callback($item);
+            }
+            $this->callbackWrapper = null;
+            $t = microtime(true);
 
-        try {
-            return $save($pool, $item, $callbackWrapper($item, $callback, $pool), $t);
-        } finally {
-            $this->callbackWrapper = $callbackWrapper;
-        }
+            try {
+                return $save($pool, $item, $callbackWrapper($item, $callback, $pool), $t);
+            } finally {
+                $this->callbackWrapper = $callbackWrapper;
+            }
+        }, $beta);
     }
 }
diff --git a/src/Symfony/Contracts/Cache/CacheInterface.php b/src/Symfony/Contracts/Cache/CacheInterface.php
@@ -11,31 +11,46 @@
 
 namespace Symfony\Contracts\Cache;
 
+use Psr\Cache\CacheItemInterface;
 use Psr\Cache\InvalidArgumentException;
 
 /**
- * Gets/Stores items from/to a cache.
- *
- * On cache misses, a callback is called that should return the missing value.
- * This callback is given an ItemInterface object corresponding to the needed key,
- * that could be used e.g. for expiration control.
+ * Covers most simple to advanced caching needs.
  *
  * @author Nicolas Grekas <p@tchwork.com>
  */
 interface CacheInterface
 {
     /**
-     * @param string                        $key      The key of the item to retrieve from the cache
-     * @param callable(ItemInterface):mixed $callback Should return the computed value for the given key/item
-     * @param float|null                    $beta     A float that, as it grows, controls the likeliness of triggering
-     *                                                early expiration. 0 disables it, INF forces immediate expiration.
-     *                                                The default (or providing null) is implementation dependent but should
-     *                                                typically be 1.0, which should provide optimal stampede protection.
-     *                                                See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration
+     * Fetches a value from the pool or computes it if not found.
+     *
+     * On cache misses, a callback is called that should return the missing value.
+     * This callback is given a PSR-6 CacheItemInterface instance corresponding to the
+     * requested key, that could be used e.g. for expiration control. It could also
+     * be an ItemInterface instance when its additional features are needed.
+     *
+     * @param string                             $key      The key of the item to retrieve from the cache
+     * @param callable(CacheItemInterface):mixed $callback Should return the computed value for the given key/item
+     * @param float|null                         $beta     A float that, as it grows, controls the likeliness of triggering
+     *                                                     early expiration. 0 disables it, INF forces immediate expiration.
+     *                                                     The default (or providing null) is implementation dependent but should
+     *                                                     typically be 1.0, which should provide optimal stampede protection.
+     *                                                     See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration
      *
      * @return mixed The value corresponding to the provided key
      *
      * @throws InvalidArgumentException When $key is not valid or when $beta is negative
      */
     public function get(string $key, callable $callback, float $beta = null);
+
+    /**
+     * Removes an item from the pool.
+     *
+     * @param string $key The key to delete
+     *
+     * @throws InvalidArgumentException When $key is not valid
+     *
+     * @return bool True if the item was successfully removed, false if there was any error
+     */
+    public function delete(string $key): bool;
 }
diff --git a/src/Symfony/Contracts/Cache/CacheTrait.php b/src/Symfony/Contracts/Cache/CacheTrait.php
@@ -0,0 +1,67 @@
+<?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\CacheItemPoolInterface;
+use Psr\Cache\InvalidArgumentException;
+
+/**
+ * An implementation of CacheInterface for PSR-6 CacheItemPoolInterface classes.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+trait CacheTrait
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function get(string $key, callable $callback, float $beta = null)
+    {
+        return $this->doGet($this, $key, $callback, $beta);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete(string $key): bool
+    {
+        return $this->deleteItem($key);
+    }
+
+    private function doGet(CacheItemPoolInterface $pool, string $key, callable $callback, ?float $beta)
+    {
+        if (0 > $beta = $beta ?? 1.0) {
+            throw new class(sprintf('Argument "$beta" provided to "%s::get()" must be a positive number, %f given.', \get_class($this), $beta)) extends \InvalidArgumentException implements InvalidArgumentException {
+            };
+        }
+
+        $item = $pool->getItem($key);
+        $recompute = !$item->isHit() || INF === $beta;
+
+        if (!$recompute && $item instanceof ItemInterface) {
+            $metadata = $item->getMetadata();
+            $expiry = $metadata[ItemInterface::METADATA_EXPIRY] ?? false;
+            $ctime = $metadata[ItemInterface::METADATA_CTIME] ?? false;
+
+            if ($recompute = $ctime && $expiry && $expiry <= microtime(true) - $ctime / 1000 * $beta * log(random_int(1, PHP_INT_MAX) / PHP_INT_MAX)) {
+                // force applying defaultLifetime to expiry
+                $item->expiresAt(null);
+            }
+        }
+
+        if ($recompute) {
+            $pool->save($item->set($callback($item)));
+        }
+
+        return $item->get();
+    }
+}