vendor/symfony/http-kernel/CacheWarmer/CacheWarmerAggregate.php line 67

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\Component\HttpKernel\CacheWarmer;
  14. /**
  15.  * Aggregates several cache warmers into a single one.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  *
  19.  * @final
  20.  */
  21. class CacheWarmerAggregate implements CacheWarmerInterface
  22. {
  23.     private $warmers;
  24.     private $debug;
  25.     private $deprecationLogsFilepath;
  26.     private $optionalsEnabled = false;
  27.     private $onlyOptionalsEnabled = false;
  29.     /**
  30.      * @param iterable<mixed, CacheWarmerInterface> $warmers
  31.      */
  32.     public function __construct(iterable $warmers = [], bool $debug = false, string $deprecationLogsFilepath = null)
  33.     {
  34.         $this->warmers = $warmers;
  35.         $this->debug = $debug;
  36.         $this->deprecationLogsFilepath = $deprecationLogsFilepath;
  37.     }
  39.     public function enableOptionalWarmers()
  40.     {
  41.         $this->optionalsEnabled = true;
  42.     }
  44.     public function enableOnlyOptionalWarmers()
  45.     {
  46.         $this->onlyOptionalsEnabled = $this->optionalsEnabled = true;
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function warmUp(string $cacheDir): array
  53.     {
  54.         if ($collectDeprecations = $this->debug && !\defined('PHPUNIT_COMPOSER_INSTALL')) {
  55.             $collectedLogs = [];
  56.             $previousHandler = set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) {
  57.                 if (\E_USER_DEPRECATED !== $type && \E_DEPRECATED !== $type) {
  58.                     return $previousHandler ? $previousHandler($type, $message, $file, $line) : false;
  59.                 }
  61.                 if (isset($collectedLogs[$message])) {
  62.                     ++$collectedLogs[$message]['count'];
  64.                     return null;
  65.                 }
  67.                 $backtrace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 3);
  68.                 // Clean the trace by removing first frames added by the error handler itself.
  69.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  70.                     if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  71.                         $backtrace = \array_slice($backtrace, 1 + $i);
  72.                         break;
  73.                     }
  74.                 }
  76.                 $collectedLogs[$message] = [
  77.                     'type' => $type,
  78.                     'message' => $message,
  79.                     'file' => $file,
  80.                     'line' => $line,
  81.                     'trace' => $backtrace,
  82.                     'count' => 1,
  83.                 ];
  85.                 return null;
  86.             });
  87.         }
  89.         $preload = [];
  90.         try {
  91.             foreach ($this->warmers as $warmer) {
  92.                 if (!$this->optionalsEnabled && $warmer->isOptional()) {
  93.                     continue;
  94.                 }
  95.                 if ($this->onlyOptionalsEnabled && !$warmer->isOptional()) {
  96.                     continue;
  97.                 }
  99.                 $preload[] = array_values((array) $warmer->warmUp($cacheDir));
  100.             }
  101.         } finally {
  102.             if ($collectDeprecations) {
  103.                 restore_error_handler();
  105.                 if (is_file($this->deprecationLogsFilepath)) {
  106.                     $previousLogs = unserialize(file_get_contents($this->deprecationLogsFilepath));
  107.                     if (\is_array($previousLogs)) {
  108.                         $collectedLogs = array_merge($previousLogs, $collectedLogs);
  109.                     }
  110.                 }
  112.                 file_put_contents($this->deprecationLogsFilepath, serialize(array_values($collectedLogs)));
  113.             }
  114.         }
  116.         return array_values(array_unique(array_merge([], ...$preload)));
  117.     }
  119.     /**
  120.      * {@inheritdoc}
  121.      */
  122.     public function isOptional(): bool
  123.     {
  124.         return false;
  125.     }
  126. }