vendor/netzmacht/contao-toolkit/src/View/Template/DelegatingTemplateRenderer.php line 47

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Netzmacht\Contao\Toolkit\View\Template;
  7. use Netzmacht\Contao\Toolkit\Exception\InvalidArgumentException;
  8. use Netzmacht\Contao\Toolkit\Exception\RuntimeException;
  9. use Twig\Environment;
  11. use function preg_match;
  12. use function sprintf;
  13. use function substr;
  15. /**
  16.  * Class DelegatingTemplateRenderer support Twig and Contao templates and delegates the rendering to the engines.
  17.  */
  18. final class DelegatingTemplateRenderer implements TemplateRenderer
  19. {
  20.     /**
  21.      * The Contao template factory.
  22.      *
  23.      * @var TemplateFactory
  24.      */
  25.     private $templateFactory;
  27.     /**
  28.      * The twig environment.
  29.      *
  30.      * @var Environment|null
  31.      */
  32.     private $twig;
  34.     /**
  35.      * @param TemplateFactory  $templateFactory The template factory.
  36.      * @param Environment|null $twig            The twig environment. If twig is not activated it's null.
  37.      */
  38.     public function __construct(TemplateFactory $templateFactory, ?Environment $twig = null)
  39.     {
  40.         $this->templateFactory = $templateFactory;
  41.         $this->twig            = $twig;
  42.     }
  44.     /**
  45.      * {@inheritDoc}
  46.      */
  47.     public function render(string $name, array $parameters = []): string
  48.     {
  49.         if (substr($name, -5) === '.twig') {
  50.             return $this->renderTwigTemplate($name, $parameters);
  51.         }
  53.         return $this->renderContaoTemplate($name, $parameters);
  54.     }
  56.     /**
  57.      * Render a twig template.
  58.      *
  59.      * @param string              $name       The template name.
  60.      * @param array<string,mixed> $parameters The parameters.
  61.      *
  62.      * @throws RuntimeException When twig is not available.
  63.      */
  64.     private function renderTwigTemplate(string $name, array $parameters): string
  65.     {
  66.         if ($this->twig === null) {
  67.             throw new RuntimeException('Twig is not available');
  68.         }
  70.         return $this->twig->render($name, $parameters);
  71.     }
  73.     /**
  74.      * Render a Contao template.
  75.      *
  76.      * @param string              $name       The template name.
  77.      * @param array<string,mixed> $parameters The parameters.
  78.      *
  79.      * @throws InvalidArgumentException When an unsupported template name is given.
  80.      */
  81.     private function renderContaoTemplate(string $name, array $parameters): string
  82.     {
  83.         [$scope, $templateName] = $this->extractScopeAndTemplateName($name);
  84.         switch ($scope) {
  85.             case 'fe':
  86.                 return $this->templateFactory->createFrontendTemplate($templateName, $parameters)->parse();
  88.             case 'be':
  89.                 return $this->templateFactory->createBackendTemplate($templateName, $parameters)->parse();
  91.             default:
  92.                 throw new InvalidArgumentException(sprintf('Template scope "%s" is not supported', $scope));
  93.         }
  94.     }
  96.     /**
  97.      * Extract the scope and template name from the whole template reference.
  98.      *
  99.      * @param string $name The template reference.
  100.      *
  101.      * @return list<string>
  102.      *
  103.      * @throws InvalidArgumentException When an unsupported template name is given.
  104.      */
  105.     private function extractScopeAndTemplateName(string $name): array
  106.     {
  107.         if (! preg_match('/^(toolkit:)?(be|fe):([^.]+)(\.html5)?$/', $name, $matches)) {
  108.             throw new InvalidArgumentException(sprintf('Template name "%s" is not supported', $name));
  109.         }
  111.         return [$matches[2], $matches[3]];
  112.     }
  113. }