vendor/ezsystems/ezpublish-kernel/eZ/Bundle/EzPublishDebugBundle/Twig/DebugTemplate.php line 18

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. namespace eZ\Bundle\EzPublishDebugBundle\Twig;
  9. use Symfony\Component\Filesystem\Filesystem;
  10. use Twig_Template;
  12. /**
  13.  * Meant to be used as a Twig base template class.
  14.  *
  15.  * Wraps the display method to:
  16.  * - Inject debug info into template to be able to see in the markup which one is used
  17.  */
  18. class DebugTemplate extends Twig_Template
  19. {
  20.     private $fileSystem;
  22.     public function display(array $context, array $blocks = [])
  23.     {
  24.         $this->fileSystem = $this->fileSystem ?: new Filesystem();
  26.         // Bufferize to be able to insert template name as HTML comments if applicable.
  27.         // Layout template name will only appear at the end, to avoid potential quirks with old browsers
  28.         // when comments appear before doctype declaration.
  29.         ob_start();
  30.         parent::display($context, $blocks);
  31.         $templateResult = ob_get_clean();
  33.         $templateName = trim($this->fileSystem->makePathRelative($this->getSourceContext()->getPath(), dirname(getcwd())), '/');
  34.         // Check if template name ends with "html.twig", indicating this is an HTML template.
  35.         $isHtmlTemplate = substr($templateName, -strlen('html.twig')) === 'html.twig';
  36.         $templateName = $isHtmlTemplate ? $templateName . ' (' . $this->getSourceContext()->getName() . ')' : $templateName;
  38.         // Display start template comment, if applicable.
  39.         if ($isHtmlTemplate) {
  40.             if (stripos(trim($templateResult), '<!doctype') !== false) {
  41.                 $templateResult = preg_replace(
  42.                     '#(<!doctype[^>]+>)#im',
  43.                     "$1\n<!-- START " . $templateName . ' -->',
  44.                     $templateResult
  45.                 );
  46.             } else {
  47.                 echo "\n<!-- START $templateName -->\n";
  48.             }
  49.         }
  51.         // Display stop template comment after result, if applicable.
  52.         if ($isHtmlTemplate) {
  53.             $bodyPos = stripos($templateResult, '</body>');
  54.             if ($bodyPos !== false) {
  55.                 // Add layout template name before </body>, to avoid display quirks in some browsers.
  56.                 echo substr($templateResult, 0, $bodyPos)
  57.                      . "\n<!-- STOP $templateName -->\n"
  58.                      . substr($templateResult, $bodyPos);
  59.             } else {
  60.                 echo $templateResult;
  61.                 echo "\n<!-- STOP $templateName -->\n";
  62.             }
  63.         } else {
  64.             echo $templateResult;
  65.         }
  66.     }
  68.     /**
  69.      * {@inheritdoc}
  70.      */
  71.     public function getTemplateName()
  72.     {
  73.         return '';
  74.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     public function getSource()
  80.     {
  81.         return '';
  82.     }
  84.     /**
  85.      * {@inheritdoc}
  86.      */
  87.     protected function doDisplay(array $context, array $blocks = [])
  88.     {
  89.         return '';
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function getDebugInfo()
  96.     {
  97.         return [];
  98.     }
  99. }