vendor/symfony/cache/Adapter/ApcuAdapter.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Cache\Adapter;
  14. use Symfony\Component\Cache\CacheItem;
  15. use Symfony\Component\Cache\Exception\CacheException;
  16. use Symfony\Component\Cache\Marshaller\MarshallerInterface;
  18. /**
  19.  * @author Nicolas Grekas <p@tchwork.com>
  20.  */
  21. class ApcuAdapter extends AbstractAdapter
  22. {
  23.     private $marshaller;
  25.     /**
  26.      * @throws CacheException if APCu is not enabled
  27.      */
  28.     public function __construct(string $namespace = '', int $defaultLifetime = 0, string $version = null, MarshallerInterface $marshaller = null)
  29.     {
  30.         if (!static::isSupported()) {
  31.             throw new CacheException('APCu is not enabled.');
  32.         }
  33.         if ('cli' === \PHP_SAPI) {
  34.             ini_set('apc.use_request_time', 0);
  35.         }
  36.         parent::__construct($namespace, $defaultLifetime);
  38.         if (null !== $version) {
  39.             CacheItem::validateKey($version);
  41.             if (!apcu_exists($version.'@'.$namespace)) {
  42.                 $this->doClear($namespace);
  43.                 apcu_add($version.'@'.$namespace, null);
  44.             }
  45.         }
  47.         $this->marshaller = $marshaller;
  48.     }
  50.     public static function isSupported()
  51.     {
  52.         return \function_exists('apcu_fetch') && filter_var(\ini_get('apc.enabled'), \FILTER_VALIDATE_BOOLEAN);
  53.     }
  55.     /**
  56.      * {@inheritdoc}
  57.      */
  58.     protected function doFetch(array $ids)
  59.     {
  60.         $unserializeCallbackHandler = ini_set('unserialize_callback_func', __CLASS__.'::handleUnserializeCallback');
  61.         try {
  62.             $values = [];
  63.             $ids = array_flip($ids);
  64.             foreach (apcu_fetch(array_keys($ids), $ok) ?: [] as $k => $v) {
  65.                 if (!isset($ids[$k])) {
  66.                     // work around https://github.com/krakjoe/apcu/issues/247
  67.                     $k = key($ids);
  68.                 }
  69.                 unset($ids[$k]);
  71.                 if (null !== $v || $ok) {
  72.                     $values[$k] = null !== $this->marshaller ? $this->marshaller->unmarshall($v) : $v;
  73.                 }
  74.             }
  76.             return $values;
  77.         } catch (\Error $e) {
  78.             throw new \ErrorException($e->getMessage(), $e->getCode(), \E_ERROR, $e->getFile(), $e->getLine());
  79.         } finally {
  80.             ini_set('unserialize_callback_func', $unserializeCallbackHandler);
  81.         }
  82.     }
  84.     /**
  85.      * {@inheritdoc}
  86.      */
  87.     protected function doHave(string $id)
  88.     {
  89.         return apcu_exists($id);
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     protected function doClear(string $namespace)
  96.     {
  97.         return isset($namespace[0]) && class_exists(\APCUIterator::class, false) && ('cli' !== \PHP_SAPI || filter_var(\ini_get('apc.enable_cli'), \FILTER_VALIDATE_BOOLEAN))
  98.             ? apcu_delete(new \APCUIterator(sprintf('/^%s/', preg_quote($namespace, '/')), \APC_ITER_KEY))
  99.             : apcu_clear_cache();
  100.     }
  102.     /**
  103.      * {@inheritdoc}
  104.      */
  105.     protected function doDelete(array $ids)
  106.     {
  107.         foreach ($ids as $id) {
  108.             apcu_delete($id);
  109.         }
  111.         return true;
  112.     }
  114.     /**
  115.      * {@inheritdoc}
  116.      */
  117.     protected function doSave(array $values, int $lifetime)
  118.     {
  119.         if (null !== $this->marshaller && (!$values = $this->marshaller->marshall($values, $failed))) {
  120.             return $failed;
  121.         }
  123.         try {
  124.             if (false === $failures = apcu_store($values, null, $lifetime)) {
  125.                 $failures = $values;
  126.             }
  128.             return array_keys($failures);
  129.         } catch (\Throwable $e) {
  130.             if (1 === \count($values)) {
  131.                 // Workaround https://github.com/krakjoe/apcu/issues/170
  132.                 apcu_delete(array_key_first($values));
  133.             }
  135.             throw $e;
  136.         }
  137.     }
  138. }