vendor/symfony/framework-bundle/CacheWarmer/AnnotationsCacheWarmer.php line 35

  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 Doctrine\Common\Annotations\PsrCachedReader;
  16. use Doctrine\Common\Annotations\Reader;
  17. use Symfony\Component\Cache\Adapter\ArrayAdapter;
  18. use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
  20. /**
  21.  * Warms up annotation caches for classes found in composer's autoload class map
  22.  * and declared in DI bundle extensions using the addAnnotatedClassesToCache method.
  23.  *
  24.  * @author Titouan Galopin <galopintitouan@gmail.com>
  25.  */
  26. class AnnotationsCacheWarmer extends AbstractPhpFileCacheWarmer
  27. {
  28.     private Reader $annotationReader;
  29.     private ?string $excludeRegexp;
  30.     private bool $debug;
  32.     /**
  33.      * @param string $phpArrayFile The PHP file where annotations are cached
  34.      */
  35.     public function __construct(Reader $annotationReader, string $phpArrayFile, string $excludeRegexp = null, bool $debug = false)
  36.     {
  37.         parent::__construct($phpArrayFile);
  38.         $this->annotationReader = $annotationReader;
  39.         $this->excludeRegexp = $excludeRegexp;
  40.         $this->debug = $debug;
  41.     }
  43.     protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
  44.     {
  45.         $annotatedClassPatterns = $cacheDir.'/annotations.map';
  47.         if (!is_file($annotatedClassPatterns)) {
  48.             return true;
  49.         }
  51.         $annotatedClasses = include $annotatedClassPatterns;
  52.         $reader = new PsrCachedReader($this->annotationReader, $arrayAdapter, $this->debug);
  54.         foreach ($annotatedClasses as $class) {
  55.             if (null !== $this->excludeRegexp && preg_match($this->excludeRegexp, $class)) {
  56.                 continue;
  57.             }
  58.             try {
  59.                 $this->readAllComponents($reader, $class);
  60.             } catch (\Exception $e) {
  61.                 $this->ignoreAutoloadException($class, $e);
  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.     private function readAllComponents(Reader $reader, string $class)
  80.     {
  81.         $reflectionClass = new \ReflectionClass($class);
  83.         try {
  84.             $reader->getClassAnnotations($reflectionClass);
  85.         } catch (AnnotationException) {
  86.             /*
  87.              * Ignore any AnnotationException to not break the cache warming process if an Annotation is badly
  88.              * configured or could not be found / read / etc.
  89.              *
  90.              * In particular cases, an Annotation in your code can be used and defined only for a specific
  91.              * environment but is always added to the annotations.map file by some Symfony default behaviors,
  92.              * and you always end up with a not found Annotation.
  93.              */
  94.         }
  96.         foreach ($reflectionClass->getMethods() as $reflectionMethod) {
  97.             try {
  98.                 $reader->getMethodAnnotations($reflectionMethod);
  99.             } catch (AnnotationException) {
  100.             }
  101.         }
  103.         foreach ($reflectionClass->getProperties() as $reflectionProperty) {
  104.             try {
  105.                 $reader->getPropertyAnnotations($reflectionProperty);
  106.             } catch (AnnotationException) {
  107.             }
  108.         }
  109.     }
  110. }