vendor/symfony/framework-bundle/CacheWarmer/ConfigBuilderCacheWarmer.php line 34

  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 Psr\Log\LoggerInterface;
  15. use Symfony\Component\Config\Builder\ConfigBuilderGenerator;
  16. use Symfony\Component\Config\Builder\ConfigBuilderGeneratorInterface;
  17. use Symfony\Component\Config\Definition\ConfigurationInterface;
  18. use Symfony\Component\DependencyInjection\ContainerBuilder;
  19. use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
  20. use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
  21. use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
  22. use Symfony\Component\HttpKernel\KernelInterface;
  24. /**
  25.  * Generate all config builders.
  26.  *
  27.  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  28.  */
  29. class ConfigBuilderCacheWarmer implements CacheWarmerInterface
  30. {
  31.     private KernelInterface $kernel;
  32.     private ?LoggerInterface $logger;
  34.     public function __construct(KernelInterface $kernel, LoggerInterface $logger = null)
  35.     {
  36.         $this->kernel = $kernel;
  37.         $this->logger = $logger;
  38.     }
  40.     /**
  41.      * @return string[]
  42.      */
  43.     public function warmUp(string $cacheDir): array
  44.     {
  45.         $generator = new ConfigBuilderGenerator($cacheDir);
  47.         foreach ($this->kernel->getBundles() as $bundle) {
  48.             $extension = $bundle->getContainerExtension();
  49.             if (null === $extension) {
  50.                 continue;
  51.             }
  53.             try {
  54.                 $this->dumpExtension($extension, $generator);
  55.             } catch (\Exception $e) {
  56.                 $this->logger?->warning('Failed to generate ConfigBuilder for extension {extensionClass}: '.$e->getMessage(), ['exception' => $e, 'extensionClass' => $extension::class]);
  57.             }
  58.         }
  60.         // No need to preload anything
  61.         return [];
  62.     }
  64.     private function dumpExtension(ExtensionInterface $extension, ConfigBuilderGeneratorInterface $generator): void
  65.     {
  66.         $configuration = null;
  67.         if ($extension instanceof ConfigurationInterface) {
  68.             $configuration = $extension;
  69.         } elseif ($extension instanceof ConfigurationExtensionInterface) {
  70.             $configuration = $extension->getConfiguration([], new ContainerBuilder($this->kernel->getContainer()->getParameterBag()));
  71.         }
  73.         if (!$configuration) {
  74.             return;
  75.         }
  77.         $generator->build($configuration);
  78.     }
  80.     public function isOptional(): bool
  81.     {
  82.         return true;
  83.     }
  84. }