vendor/symfony/cache/Adapter/ChainAdapter.php line 120

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Cache\Adapter;
  11. use Psr\Cache\CacheItemInterface;
  12. use Psr\Cache\CacheItemPoolInterface;
  13. use Symfony\Component\Cache\CacheItem;
  14. use Symfony\Component\Cache\Exception\InvalidArgumentException;
  15. use Symfony\Component\Cache\PruneableInterface;
  16. use Symfony\Component\Cache\ResettableInterface;
  17. use Symfony\Component\Cache\Traits\ContractsTrait;
  18. use Symfony\Contracts\Cache\CacheInterface;
  19. use Symfony\Contracts\Service\ResetInterface;
  20. /**
  21.  * Chains several adapters together.
  22.  *
  23.  * Cached items are fetched from the first adapter having them in its data store.
  24.  * They are saved and deleted in all adapters at once.
  25.  *
  26.  * @author Kévin Dunglas <dunglas@gmail.com>
  27.  */
  28. class ChainAdapter implements AdapterInterfaceCacheInterfacePruneableInterfaceResettableInterface
  29. {
  30.     use ContractsTrait;
  31.     private $adapters = [];
  32.     private $adapterCount;
  33.     private $syncItem;
  34.     /**
  35.      * @param CacheItemPoolInterface[] $adapters        The ordered list of adapters used to fetch cached items
  36.      * @param int                      $defaultLifetime The default lifetime of items propagated from lower adapters to upper ones
  37.      */
  38.     public function __construct(array $adaptersint $defaultLifetime 0)
  39.     {
  40.         if (!$adapters) {
  41.             throw new InvalidArgumentException('At least one adapter must be specified.');
  42.         }
  43.         foreach ($adapters as $adapter) {
  44.             if (!$adapter instanceof CacheItemPoolInterface) {
  45.                 throw new InvalidArgumentException(sprintf('The class "%s" does not implement the "%s" interface.', \get_class($adapter), CacheItemPoolInterface::class));
  46.             }
  47.             if (\in_array(\PHP_SAPI, ['cli''phpdbg'], true) && $adapter instanceof ApcuAdapter && !filter_var(ini_get('apc.enable_cli'), \FILTER_VALIDATE_BOOLEAN)) {
  48.                 continue; // skip putting APCu in the chain when the backend is disabled
  49.             }
  50.             if ($adapter instanceof AdapterInterface) {
  51.                 $this->adapters[] = $adapter;
  52.             } else {
  53.                 $this->adapters[] = new ProxyAdapter($adapter);
  54.             }
  55.         }
  56.         $this->adapterCount = \count($this->adapters);
  57.         $this->syncItem = \Closure::bind(
  58.             static function ($sourceItem$item$sourceMetadata null) use ($defaultLifetime) {
  59.                 $sourceItem->isTaggable false;
  60.                 $sourceMetadata $sourceMetadata ?? $sourceItem->metadata;
  61.                 unset($sourceMetadata[CacheItem::METADATA_TAGS]);
  62.                 $item->value $sourceItem->value;
  63.                 $item->isHit $sourceItem->isHit;
  64.                 $item->metadata $item->newMetadata $sourceItem->metadata $sourceMetadata;
  65.                 if (isset($item->metadata[CacheItem::METADATA_EXPIRY])) {
  66.                     $item->expiresAt(\DateTime::createFromFormat('U.u'sprintf('%.6F'$item->metadata[CacheItem::METADATA_EXPIRY])));
  67.                 } elseif ($defaultLifetime) {
  68.                     $item->expiresAfter($defaultLifetime);
  69.                 }
  70.                 return $item;
  71.             },
  72.             null,
  73.             CacheItem::class
  74.         );
  75.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     public function get(string $key, callable $callbackfloat $beta null, array &$metadata null)
  80.     {
  81.         $lastItem null;
  82.         $i 0;
  83.         $wrap = function (CacheItem $item null) use ($key$callback$beta, &$wrap, &$i, &$lastItem, &$metadata) {
  84.             $adapter $this->adapters[$i];
  85.             if (isset($this->adapters[++$i])) {
  86.                 $callback $wrap;
  87.                 $beta = \INF === $beta ? \INF 0;
  88.             }
  89.             if ($adapter instanceof CacheInterface) {
  90.                 $value $adapter->get($key$callback$beta$metadata);
  91.             } else {
  92.                 $value $this->doGet($adapter$key$callback$beta$metadata);
  93.             }
  94.             if (null !== $item) {
  95.                 ($this->syncItem)($lastItem $lastItem ?? $item$item$metadata);
  96.             }
  97.             return $value;
  98.         };
  99.         return $wrap();
  100.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function getItem($key)
  105.     {
  106.         $syncItem $this->syncItem;
  107.         $misses = [];
  108.         foreach ($this->adapters as $i => $adapter) {
  109.             $item $adapter->getItem($key);
  110.             if ($item->isHit()) {
  111.                 while (<= --$i) {
  112.                     $this->adapters[$i]->save($syncItem($item$misses[$i]));
  113.                 }
  114.                 return $item;
  115.             }
  116.             $misses[$i] = $item;
  117.         }
  118.         return $item;
  119.     }
  120.     /**
  121.      * {@inheritdoc}
  122.      */
  123.     public function getItems(array $keys = [])
  124.     {
  125.         return $this->generateItems($this->adapters[0]->getItems($keys), 0);
  126.     }
  127.     private function generateItems(iterable $itemsint $adapterIndex)
  128.     {
  129.         $missing = [];
  130.         $misses = [];
  131.         $nextAdapterIndex $adapterIndex 1;
  132.         $nextAdapter $this->adapters[$nextAdapterIndex] ?? null;
  133.         foreach ($items as $k => $item) {
  134.             if (!$nextAdapter || $item->isHit()) {
  135.                 yield $k => $item;
  136.             } else {
  137.                 $missing[] = $k;
  138.                 $misses[$k] = $item;
  139.             }
  140.         }
  141.         if ($missing) {
  142.             $syncItem $this->syncItem;
  143.             $adapter $this->adapters[$adapterIndex];
  144.             $items $this->generateItems($nextAdapter->getItems($missing), $nextAdapterIndex);
  145.             foreach ($items as $k => $item) {
  146.                 if ($item->isHit()) {
  147.                     $adapter->save($syncItem($item$misses[$k]));
  148.                 }
  149.                 yield $k => $item;
  150.             }
  151.         }
  152.     }
  153.     /**
  154.      * {@inheritdoc}
  155.      *
  156.      * @return bool
  157.      */
  158.     public function hasItem($key)
  159.     {
  160.         foreach ($this->adapters as $adapter) {
  161.             if ($adapter->hasItem($key)) {
  162.                 return true;
  163.             }
  164.         }
  165.         return false;
  166.     }
  167.     /**
  168.      * {@inheritdoc}
  169.      *
  170.      * @param string $prefix
  171.      *
  172.      * @return bool
  173.      */
  174.     public function clear(/*string $prefix = ''*/)
  175.     {
  176.         $prefix < \func_num_args() ? (string) func_get_arg(0) : '';
  177.         $cleared true;
  178.         $i $this->adapterCount;
  179.         while ($i--) {
  180.             if ($this->adapters[$i] instanceof AdapterInterface) {
  181.                 $cleared $this->adapters[$i]->clear($prefix) && $cleared;
  182.             } else {
  183.                 $cleared $this->adapters[$i]->clear() && $cleared;
  184.             }
  185.         }
  186.         return $cleared;
  187.     }
  188.     /**
  189.      * {@inheritdoc}
  190.      *
  191.      * @return bool
  192.      */
  193.     public function deleteItem($key)
  194.     {
  195.         $deleted true;
  196.         $i $this->adapterCount;
  197.         while ($i--) {
  198.             $deleted $this->adapters[$i]->deleteItem($key) && $deleted;
  199.         }
  200.         return $deleted;
  201.     }
  202.     /**
  203.      * {@inheritdoc}
  204.      *
  205.      * @return bool
  206.      */
  207.     public function deleteItems(array $keys)
  208.     {
  209.         $deleted true;
  210.         $i $this->adapterCount;
  211.         while ($i--) {
  212.             $deleted $this->adapters[$i]->deleteItems($keys) && $deleted;
  213.         }
  214.         return $deleted;
  215.     }
  216.     /**
  217.      * {@inheritdoc}
  218.      *
  219.      * @return bool
  220.      */
  221.     public function save(CacheItemInterface $item)
  222.     {
  223.         $saved true;
  224.         $i $this->adapterCount;
  225.         while ($i--) {
  226.             $saved $this->adapters[$i]->save($item) && $saved;
  227.         }
  228.         return $saved;
  229.     }
  230.     /**
  231.      * {@inheritdoc}
  232.      *
  233.      * @return bool
  234.      */
  235.     public function saveDeferred(CacheItemInterface $item)
  236.     {
  237.         $saved true;
  238.         $i $this->adapterCount;
  239.         while ($i--) {
  240.             $saved $this->adapters[$i]->saveDeferred($item) && $saved;
  241.         }
  242.         return $saved;
  243.     }
  244.     /**
  245.      * {@inheritdoc}
  246.      *
  247.      * @return bool
  248.      */
  249.     public function commit()
  250.     {
  251.         $committed true;
  252.         $i $this->adapterCount;
  253.         while ($i--) {
  254.             $committed $this->adapters[$i]->commit() && $committed;
  255.         }
  256.         return $committed;
  257.     }
  258.     /**
  259.      * {@inheritdoc}
  260.      */
  261.     public function prune()
  262.     {
  263.         $pruned true;
  264.         foreach ($this->adapters as $adapter) {
  265.             if ($adapter instanceof PruneableInterface) {
  266.                 $pruned $adapter->prune() && $pruned;
  267.             }
  268.         }
  269.         return $pruned;
  270.     }
  271.     /**
  272.      * {@inheritdoc}
  273.      */
  274.     public function reset()
  275.     {
  276.         foreach ($this->adapters as $adapter) {
  277.             if ($adapter instanceof ResetInterface) {
  278.                 $adapter->reset();
  279.             }
  280.         }
  281.     }
  282. }