vendor/symfony/twig-bridge/Form/TwigRendererEngine.php line 98

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\Bridge\Twig\Form;
  14. use Symfony\Component\Form\AbstractRendererEngine;
  15. use Symfony\Component\Form\FormView;
  16. use Twig\Environment;
  17. use Twig\Template;
  19. /**
  20.  * @author Bernhard Schussek <bschussek@gmail.com>
  21.  */
  22. class TwigRendererEngine extends AbstractRendererEngine
  23. {
  24.     private Environment $environment;
  25.     private Template $template;
  27.     public function __construct(array $defaultThemes, Environment $environment)
  28.     {
  29.         parent::__construct($defaultThemes);
  30.         $this->environment = $environment;
  31.     }
  33.     /**
  34.      * {@inheritdoc}
  35.      */
  36.     public function renderBlock(FormView $view, mixed $resource, string $blockName, array $variables = []): string
  37.     {
  38.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  40.         $context = $this->environment->mergeGlobals($variables);
  42.         ob_start();
  44.         // By contract,This method can only be called after getting the resource
  45.         // (which is passed to the method). Getting a resource for the first time
  46.         // (with an empty cache) is guaranteed to invoke loadResourcesFromTheme(),
  47.         // where the property $template is initialized.
  49.         // We do not call renderBlock here to avoid too many nested level calls
  50.         // (XDebug limits the level to 100 by default)
  51.         $this->template->displayBlock($blockName, $context, $this->resources[$cacheKey]);
  53.         return ob_get_clean();
  54.     }
  56.     /**
  57.      * Loads the cache with the resource for a given block name.
  58.      *
  59.      * This implementation eagerly loads all blocks of the themes assigned to the given view
  60.      * and all of its ancestors views. This is necessary, because Twig receives the
  61.      * list of blocks later. At that point, all blocks must already be loaded, for the
  62.      * case that the function "block()" is used in the Twig template.
  63.      *
  64.      * @see getResourceForBlock()
  65.      */
  66.     protected function loadResourceForBlockName(string $cacheKey, FormView $view, string $blockName): bool
  67.     {
  68.         // The caller guarantees that $this->resources[$cacheKey][$block] is
  69.         // not set, but it doesn't have to check whether $this->resources[$cacheKey]
  70.         // is set. If $this->resources[$cacheKey] is set, all themes for this
  71.         // $cacheKey are already loaded (due to the eager population, see doc comment).
  72.         if (isset($this->resources[$cacheKey])) {
  73.             // As said in the previous, the caller guarantees that
  74.             // $this->resources[$cacheKey][$block] is not set. Since the themes are
  75.             // already loaded, it can only be a non-existing block.
  76.             $this->resources[$cacheKey][$blockName] = false;
  78.             return false;
  79.         }
  81.         // Recursively try to find the block in the themes assigned to $view,
  82.         // then of its parent view, then of the parent view of the parent and so on.
  83.         // When the root view is reached in this recursion, also the default
  84.         // themes are taken into account.
  86.         // Check each theme whether it contains the searched block
  87.         if (isset($this->themes[$cacheKey])) {
  88.             for ($i = \count($this->themes[$cacheKey]) - 1; $i >= 0; --$i) {
  89.                 $this->loadResourcesFromTheme($cacheKey, $this->themes[$cacheKey][$i]);
  90.                 // CONTINUE LOADING (see doc comment)
  91.             }
  92.         }
  94.         // Check the default themes once we reach the root view without success
  95.         if (!$view->parent) {
  96.             if (!isset($this->useDefaultThemes[$cacheKey]) || $this->useDefaultThemes[$cacheKey]) {
  97.                 for ($i = \count($this->defaultThemes) - 1; $i >= 0; --$i) {
  98.                     $this->loadResourcesFromTheme($cacheKey, $this->defaultThemes[$i]);
  99.                     // CONTINUE LOADING (see doc comment)
  100.                 }
  101.             }
  102.         }
  104.         // Proceed with the themes of the parent view
  105.         if ($view->parent) {
  106.             $parentCacheKey = $view->parent->vars[self::CACHE_KEY_VAR];
  108.             if (!isset($this->resources[$parentCacheKey])) {
  109.                 $this->loadResourceForBlockName($parentCacheKey, $view->parent, $blockName);
  110.             }
  112.             // EAGER CACHE POPULATION (see doc comment)
  113.             foreach ($this->resources[$parentCacheKey] as $nestedBlockName => $resource) {
  114.                 if (!isset($this->resources[$cacheKey][$nestedBlockName])) {
  115.                     $this->resources[$cacheKey][$nestedBlockName] = $resource;
  116.                 }
  117.             }
  118.         }
  120.         // Even though we loaded the themes, it can happen that none of them
  121.         // contains the searched block
  122.         if (!isset($this->resources[$cacheKey][$blockName])) {
  123.             // Cache that we didn't find anything to speed up further accesses
  124.             $this->resources[$cacheKey][$blockName] = false;
  125.         }
  127.         return false !== $this->resources[$cacheKey][$blockName];
  128.     }
  130.     /**
  131.      * Loads the resources for all blocks in a theme.
  132.      *
  133.      * @param mixed $theme The theme to load the block from. This parameter
  134.      *                     is passed by reference, because it might be necessary
  135.      *                     to initialize the theme first. Any changes made to
  136.      *                     this variable will be kept and be available upon
  137.      *                     further calls to this method using the same theme.
  138.      */
  139.     protected function loadResourcesFromTheme(string $cacheKey, mixed &$theme)
  140.     {
  141.         if (!$theme instanceof Template) {
  142.             $theme = $this->environment->load($theme)->unwrap();
  143.         }
  145.         // Store the first Template instance that we find so that
  146.         // we can call displayBlock() later on. It doesn't matter *which*
  147.         // template we use for that, since we pass the used blocks manually
  148.         // anyway.
  149.         $this->template ??= $theme;
  151.         // Use a separate variable for the inheritance traversal, because
  152.         // theme is a reference and we don't want to change it.
  153.         $currentTheme = $theme;
  155.         $context = $this->environment->mergeGlobals([]);
  157.         // The do loop takes care of template inheritance.
  158.         // Add blocks from all templates in the inheritance tree, but avoid
  159.         // overriding blocks already set.
  160.         do {
  161.             foreach ($currentTheme->getBlocks() as $block => $blockData) {
  162.                 if (!isset($this->resources[$cacheKey][$block])) {
  163.                     // The resource given back is the key to the bucket that
  164.                     // contains this block.
  165.                     $this->resources[$cacheKey][$block] = $blockData;
  166.                 }
  167.             }
  168.         } while (false !== $currentTheme = $currentTheme->getParent($context));
  169.     }
  170. }