vendor/netgen/site-bundle/bundle/Templating/Twig/BaseDebugTemplate.php line 30

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Netgen\Bundle\SiteBundle\Templating\Twig;
  7. use Symfony\Component\Filesystem\Filesystem;
  8. use Twig\Template;
  10. use function dirname;
  11. use function getcwd;
  12. use function implode;
  13. use function mb_stripos;
  14. use function mb_substr;
  15. use function preg_replace;
  16. use function str_contains;
  17. use function str_ends_with;
  18. use function trim;
  20. /**
  21. * Meant to be used as a Twig base template class.
  22. *
  23. * Wraps the yield method to:
  24. * - Inject debug info into template to be able to see in the markup which one is used
  25. */
  26. abstract class BaseDebugTemplate extends Template
  27. {
  28. private Filesystem $fileSystem;
  30. public function yield(array $context, array $blocks = []): iterable
  31. {
  32. $this->fileSystem = $this->fileSystem ?? new Filesystem();
  34. // Get parent result to be able to insert template name as HTML comments if applicable.
  35. // Layout template name will only appear at the end, to avoid potential quirks with old browsers
  36. // when comments appear before doctype declaration.
  37. $templateResult = implode('', [...parent::yield($context, $blocks)]);
  39. $templateName = trim($this->fileSystem->makePathRelative($this->getSourceContext()->getPath(), dirname((string) getcwd())), '/');
  40. $isHtmlTemplate = str_ends_with($templateName, 'html.twig');
  41. $templateName = $isHtmlTemplate ? $templateName . ' (' . $this->getSourceContext()->getName() . ')' : $templateName;
  43. // Display start template comment, if applicable.
  44. if ($isHtmlTemplate) {
  45. if (str_contains(trim($templateResult), '<!doctype')) {
  46. $templateResult = (string) preg_replace(
  47. '#(<!doctype[^>]+>)#im',
  48. "$1\n<!-- START " . $templateName . ' -->',
  49. $templateResult,
  50. );
  51. } else {
  52. yield "\n<!-- START " . $templateName . " -->\n";
  53. }
  54. }
  56. // Display stop template comment after result, if applicable.
  57. if ($isHtmlTemplate) {
  58. if (str_contains($templateResult, '</body>')) {
  59. $bodyPos = (int) mb_stripos($templateResult, '</body>');
  61. // Add layout template name before </body>, to avoid display quirks in some browsers.
  62. yield mb_substr($templateResult, 0, $bodyPos)
  63. . "\n<!-- STOP " . $templateName . " -->\n"
  64. . mb_substr($templateResult, $bodyPos);
  65. } else {
  66. yield $templateResult;
  68. yield "\n<!-- STOP " . $templateName . " -->\n";
  69. }
  70. } else {
  71. yield $templateResult;
  72. }
  73. }
  74. }