vendor/symfony/twig-bridge/DataCollector/TwigDataCollector.php line 41

  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\Bridge\Twig\DataCollector;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\HttpKernel\DataCollector\DataCollector;
  17. use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
  18. use Twig\Environment;
  19. use Twig\Error\LoaderError;
  20. use Twig\Markup;
  21. use Twig\Profiler\Dumper\HtmlDumper;
  22. use Twig\Profiler\Profile;
  24. /**
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  *
  27.  * @final
  28.  */
  29. class TwigDataCollector extends DataCollector implements LateDataCollectorInterface
  30. {
  31.     private Profile $profile;
  32.     private ?Environment $twig;
  33.     private array $computed;
  35.     public function __construct(Profile $profile, Environment $twig = null)
  36.     {
  37.         $this->profile = $profile;
  38.         $this->twig = $twig;
  39.     }
  41.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  42.     {
  43.     }
  45.     public function reset()
  46.     {
  47.         $this->profile->reset();
  48.         unset($this->computed);
  49.         $this->data = [];
  50.     }
  52.     public function lateCollect()
  53.     {
  54.         $this->data['profile'] = serialize($this->profile);
  55.         $this->data['template_paths'] = [];
  57.         if (null === $this->twig) {
  58.             return;
  59.         }
  61.         $templateFinder = function (Profile $profile) use (&$templateFinder) {
  62.             if ($profile->isTemplate()) {
  63.                 try {
  64.                     $template = $this->twig->load($name = $profile->getName());
  65.                 } catch (LoaderError) {
  66.                     $template = null;
  67.                 }
  69.                 if (null !== $template && '' !== $path = $template->getSourceContext()->getPath()) {
  70.                     $this->data['template_paths'][$name] = $path;
  71.                 }
  72.             }
  74.             foreach ($profile as $p) {
  75.                 $templateFinder($p);
  76.             }
  77.         };
  78.         $templateFinder($this->profile);
  79.     }
  81.     public function getTime()
  82.     {
  83.         return $this->getProfile()->getDuration() * 1000;
  84.     }
  86.     public function getTemplateCount()
  87.     {
  88.         return $this->getComputedData('template_count');
  89.     }
  91.     public function getTemplatePaths()
  92.     {
  93.         return $this->data['template_paths'];
  94.     }
  96.     public function getTemplates()
  97.     {
  98.         return $this->getComputedData('templates');
  99.     }
  101.     public function getBlockCount()
  102.     {
  103.         return $this->getComputedData('block_count');
  104.     }
  106.     public function getMacroCount()
  107.     {
  108.         return $this->getComputedData('macro_count');
  109.     }
  111.     public function getHtmlCallGraph()
  112.     {
  113.         $dumper = new HtmlDumper();
  114.         $dump = $dumper->dump($this->getProfile());
  116.         // needed to remove the hardcoded CSS styles
  117.         $dump = str_replace([
  118.             '<span style="background-color: #ffd">',
  119.             '<span style="color: #d44">',
  120.             '<span style="background-color: #dfd">',
  121.             '<span style="background-color: #ddf">',
  122.         ], [
  123.             '<span class="status-warning">',
  124.             '<span class="status-error">',
  125.             '<span class="status-success">',
  126.             '<span class="status-info">',
  127.         ], $dump);
  129.         return new Markup($dump, 'UTF-8');
  130.     }
  132.     public function getProfile()
  133.     {
  134.         return $this->profile ??= unserialize($this->data['profile'], ['allowed_classes' => ['Twig_Profiler_Profile', Profile::class]]);
  135.     }
  137.     private function getComputedData(string $index)
  138.     {
  139.         $this->computed ??= $this->computeData($this->getProfile());
  141.         return $this->computed[$index];
  142.     }
  144.     private function computeData(Profile $profile)
  145.     {
  146.         $data = [
  147.             'template_count' => 0,
  148.             'block_count' => 0,
  149.             'macro_count' => 0,
  150.         ];
  152.         $templates = [];
  153.         foreach ($profile as $p) {
  154.             $d = $this->computeData($p);
  156.             $data['template_count'] += ($p->isTemplate() ? 1 : 0) + $d['template_count'];
  157.             $data['block_count'] += ($p->isBlock() ? 1 : 0) + $d['block_count'];
  158.             $data['macro_count'] += ($p->isMacro() ? 1 : 0) + $d['macro_count'];
  160.             if ($p->isTemplate()) {
  161.                 if (!isset($templates[$p->getTemplate()])) {
  162.                     $templates[$p->getTemplate()] = 1;
  163.                 } else {
  164.                     ++$templates[$p->getTemplate()];
  165.                 }
  166.             }
  168.             foreach ($d['templates'] as $template => $count) {
  169.                 if (!isset($templates[$template])) {
  170.                     $templates[$template] = $count;
  171.                 } else {
  172.                     $templates[$template] += $count;
  173.                 }
  174.             }
  175.         }
  176.         $data['templates'] = $templates;
  178.         return $data;
  179.     }
  181.     public function getName(): string
  182.     {
  183.         return 'twig';
  184.     }
  185. }