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

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 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 $annotationReader;
  29.     private $excludeRegexp;
  30.     private $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.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter)
  47.     {
  48.         $annotatedClassPatterns = $cacheDir.'/annotations.map';
  50.         if (!is_file($annotatedClassPatterns)) {
  51.             return true;
  52.         }
  54.         $annotatedClasses = include $annotatedClassPatterns;
  55.         $reader = new PsrCachedReader($this->annotationReader, $arrayAdapter, $this->debug);
  57.         foreach ($annotatedClasses as $class) {
  58.             if (null !== $this->excludeRegexp && preg_match($this->excludeRegexp, $class)) {
  59.                 continue;
  60.             }
  61.             try {
  62.                 $this->readAllComponents($reader, $class);
  63.             } catch (\Exception $e) {
  64.                 $this->ignoreAutoloadException($class, $e);
  65.             }
  66.         }
  68.         return true;
  69.     }
  71.     /**
  72.      * @return string[] A list of classes to preload on PHP 7.4+
  73.      */
  74.     protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values)
  75.     {
  76.         // make sure we don't cache null values
  77.         $values = array_filter($values, function ($val) { return null !== $val; });
  79.         return parent::warmUpPhpArrayAdapter($phpArrayAdapter, $values);
  80.     }
  82.     private function readAllComponents(Reader $reader, string $class)
  83.     {
  84.         $reflectionClass = new \ReflectionClass($class);
  86.         try {
  87.             $reader->getClassAnnotations($reflectionClass);
  88.         } catch (AnnotationException $e) {
  89.             /*
  90.              * Ignore any AnnotationException to not break the cache warming process if an Annotation is badly
  91.              * configured or could not be found / read / etc.
  92.              *
  93.              * In particular cases, an Annotation in your code can be used and defined only for a specific
  94.              * environment but is always added to the annotations.map file by some Symfony default behaviors,
  95.              * and you always end up with a not found Annotation.
  96.              */
  97.         }
  99.         foreach ($reflectionClass->getMethods() as $reflectionMethod) {
  100.             try {
  101.                 $reader->getMethodAnnotations($reflectionMethod);
  102.             } catch (AnnotationException $e) {
  103.             }
  104.         }
  106.         foreach ($reflectionClass->getProperties() as $reflectionProperty) {
  107.             try {
  108.                 $reader->getPropertyAnnotations($reflectionProperty);
  109.             } catch (AnnotationException $e) {
  110.             }
  111.         }
  112.     }
  113. }