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

  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.     public function isOptional(): bool
  33.     {
  34.         return true;
  35.     }
  37.     /**
  38.      * @return string[] A list of classes to preload on PHP 7.4+
  39.      */
  40.     public function warmUp(string $cacheDir): array
  41.     {
  42.         $arrayAdapter = new ArrayAdapter();
  44.         spl_autoload_register([ClassExistenceResource::class, 'throwOnRequiredClass']);
  45.         try {
  46.             if (!$this->doWarmUp($cacheDir, $arrayAdapter)) {
  47.                 return [];
  48.             }
  49.         } finally {
  50.             spl_autoload_unregister([ClassExistenceResource::class, 'throwOnRequiredClass']);
  51.         }
  53.         // the ArrayAdapter stores the values serialized
  54.         // to avoid mutation of the data after it was written to the cache
  55.         // so here we un-serialize the values first
  56.         $values = array_map(function ($val) { return null !== $val ? unserialize($val) : null; }, $arrayAdapter->getValues());
  58.         return $this->warmUpPhpArrayAdapter(new PhpArrayAdapter($this->phpArrayFile, new NullAdapter()), $values);
  59.     }
  61.     /**
  62.      * @return string[] A list of classes to preload on PHP 7.4+
  63.      */
  64.     protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values): array
  65.     {
  66.         return (array) $phpArrayAdapter->warmUp($values);
  67.     }
  69.     /**
  70.      * @internal
  71.      */
  72.     final protected function ignoreAutoloadException(string $class, \Exception $exception): void
  73.     {
  74.         try {
  75.             ClassExistenceResource::throwOnRequiredClass($class, $exception);
  76.         } catch (\ReflectionException) {
  77.         }
  78.     }
  80.     /**
  81.      * @return bool false if there is nothing to warm-up
  82.      */
  83.     abstract protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool;
  84. }