vendor/symfony/framework-bundle/CacheWarmer/ValidatorCacheWarmer.php line 49

  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 Doctrine\Common\Annotations\AnnotationException;
  15. use Symfony\Component\Cache\Adapter\ArrayAdapter;
  16. use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
  17. use Symfony\Component\Validator\Mapping\Factory\LazyLoadingMetadataFactory;
  18. use Symfony\Component\Validator\Mapping\Loader\LoaderChain;
  19. use Symfony\Component\Validator\Mapping\Loader\LoaderInterface;
  20. use Symfony\Component\Validator\Mapping\Loader\XmlFileLoader;
  21. use Symfony\Component\Validator\Mapping\Loader\YamlFileLoader;
  22. use Symfony\Component\Validator\ValidatorBuilder;
  24. /**
  25.  * Warms up XML and YAML validator metadata.
  26.  *
  27.  * @author Titouan Galopin <galopintitouan@gmail.com>
  28.  */
  29. class ValidatorCacheWarmer extends AbstractPhpFileCacheWarmer
  30. {
  31.     private ValidatorBuilder $validatorBuilder;
  33.     /**
  34.      * @param string $phpArrayFile The PHP file where metadata are cached
  35.      */
  36.     public function __construct(ValidatorBuilder $validatorBuilder, string $phpArrayFile)
  37.     {
  38.         parent::__construct($phpArrayFile);
  39.         $this->validatorBuilder = $validatorBuilder;
  40.     }
  42.     protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
  43.     {
  44.         if (!method_exists($this->validatorBuilder, 'getLoaders')) {
  45.             return false;
  46.         }
  48.         $loaders = $this->validatorBuilder->getLoaders();
  49.         $metadataFactory = new LazyLoadingMetadataFactory(new LoaderChain($loaders), $arrayAdapter);
  51.         foreach ($this->extractSupportedLoaders($loaders) as $loader) {
  52.             foreach ($loader->getMappedClasses() as $mappedClass) {
  53.                 try {
  54.                     if ($metadataFactory->hasMetadataFor($mappedClass)) {
  55.                         $metadataFactory->getMetadataFor($mappedClass);
  56.                     }
  57.                 } catch (AnnotationException) {
  58.                     // ignore failing annotations
  59.                 } catch (\Exception $e) {
  60.                     $this->ignoreAutoloadException($mappedClass, $e);
  61.                 }
  62.             }
  63.         }
  65.         return true;
  66.     }
  68.     /**
  69.      * @return string[] A list of classes to preload on PHP 7.4+
  70.      */
  71.     protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values): array
  72.     {
  73.         // make sure we don't cache null values
  74.         $values = array_filter($values, function ($val) { return null !== $val; });
  76.         return parent::warmUpPhpArrayAdapter($phpArrayAdapter, $values);
  77.     }
  79.     /**
  80.      * @param LoaderInterface[] $loaders
  81.      *
  82.      * @return XmlFileLoader[]|YamlFileLoader[]
  83.      */
  84.     private function extractSupportedLoaders(array $loaders): array
  85.     {
  86.         $supportedLoaders = [];
  88.         foreach ($loaders as $loader) {
  89.             if ($loader instanceof XmlFileLoader || $loader instanceof YamlFileLoader) {
  90.                 $supportedLoaders[] = $loader;
  91.             } elseif ($loader instanceof LoaderChain) {
  92.                 $supportedLoaders = array_merge($supportedLoaders, $this->extractSupportedLoaders($loader->getLoaders()));
  93.             }
  94.         }
  96.         return $supportedLoaders;
  97.     }
  98. }