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

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