vendor/symfony/framework-bundle/CacheWarmer/AbstractPhpFileCacheWarmer.php line 63

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\Bundle\FrameworkBundle\CacheWarmer;
  14. use Symfony\Component\Cache\Adapter\ArrayAdapter;
  15. use Symfony\Component\Cache\Adapter\NullAdapter;
  16. use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
  17. use Symfony\Component\Config\Resource\ClassExistenceResource;
  18. use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
  20. abstract class AbstractPhpFileCacheWarmer implements CacheWarmerInterface
  21. {
  22.     private string $phpArrayFile;
  24.     /**
  25.      * @param string $phpArrayFile The PHP file where metadata are cached
  26.      */
  27.     public function __construct(string $phpArrayFile)
  28.     {
  29.         $this->phpArrayFile = $phpArrayFile;
  30.     }
  32.     /**
  33.      * {@inheritdoc}
  34.      */
  35.     public function isOptional(): bool
  36.     {
  37.         return true;
  38.     }
  40.     /**
  41.      * {@inheritdoc}
  42.      *
  43.      * @return string[] A list of classes to preload on PHP 7.4+
  44.      */
  45.     public function warmUp(string $cacheDir): array
  46.     {
  47.         $arrayAdapter = new ArrayAdapter();
  49.         spl_autoload_register([ClassExistenceResource::class, 'throwOnRequiredClass']);
  50.         try {
  51.             if (!$this->doWarmUp($cacheDir, $arrayAdapter)) {
  52.                 return [];
  53.             }
  54.         } finally {
  55.             spl_autoload_unregister([ClassExistenceResource::class, 'throwOnRequiredClass']);
  56.         }
  58.         // the ArrayAdapter stores the values serialized
  59.         // to avoid mutation of the data after it was written to the cache
  60.         // so here we un-serialize the values first
  61.         $values = array_map(function ($val) { return null !== $val ? unserialize($val) : null; }, $arrayAdapter->getValues());
  63.         return $this->warmUpPhpArrayAdapter(new PhpArrayAdapter($this->phpArrayFile, new NullAdapter()), $values);
  64.     }
  66.     /**
  67.      * @return string[] A list of classes to preload on PHP 7.4+
  68.      */
  69.     protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values): array
  70.     {
  71.         return (array) $phpArrayAdapter->warmUp($values);
  72.     }
  74.     /**
  75.      * @internal
  76.      */
  77.     final protected function ignoreAutoloadException(string $class, \Exception $exception): void
  78.     {
  79.         try {
  80.             ClassExistenceResource::throwOnRequiredClass($class, $exception);
  81.         } catch (\ReflectionException) {
  82.         }
  83.     }
  85.     /**
  86.      * @return bool false if there is nothing to warm-up
  87.      */
  88.     abstract protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool;
  89. }