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

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