vendor/symfony/form/AbstractRendererEngine.php line 78

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\Component\Form;
  14. /**
  15.  * Default implementation of {@link FormRendererEngineInterface}.
  16.  *
  17.  * @author Bernhard Schussek <bschussek@gmail.com>
  18.  */
  19. abstract class AbstractRendererEngine implements FormRendererEngineInterface
  20. {
  21.     /**
  22.      * The variable in {@link FormView} used as cache key.
  23.      */
  24.     public const CACHE_KEY_VAR = 'cache_key';
  26.     protected $defaultThemes;
  27.     protected $themes = [];
  28.     protected $useDefaultThemes = [];
  29.     protected $resources = [];
  31.     private $resourceHierarchyLevels = [];
  33.     /**
  34.      * Creates a new renderer engine.
  35.      *
  36.      * @param array $defaultThemes The default themes. The type of these
  37.      *                             themes is open to the implementation.
  38.      */
  39.     public function __construct(array $defaultThemes = [])
  40.     {
  41.         $this->defaultThemes = $defaultThemes;
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function setTheme(FormView $view, $themes, $useDefaultThemes = true)
  48.     {
  49.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  51.         // Do not cast, as casting turns objects into arrays of properties
  52.         $this->themes[$cacheKey] = \is_array($themes) ? $themes : [$themes];
  53.         $this->useDefaultThemes[$cacheKey] = (bool) $useDefaultThemes;
  55.         // Unset instead of resetting to an empty array, in order to allow
  56.         // implementations (like TwigRendererEngine) to check whether $cacheKey
  57.         // is set at all.
  58.         unset($this->resources[$cacheKey], $this->resourceHierarchyLevels[$cacheKey]);
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function getResourceForBlockName(FormView $view, $blockName)
  65.     {
  66.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  68.         if (!isset($this->resources[$cacheKey][$blockName])) {
  69.             $this->loadResourceForBlockName($cacheKey, $view, $blockName);
  70.         }
  72.         return $this->resources[$cacheKey][$blockName];
  73.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      */
  78.     public function getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, $hierarchyLevel)
  79.     {
  80.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  81.         $blockName = $blockNameHierarchy[$hierarchyLevel];
  83.         if (!isset($this->resources[$cacheKey][$blockName])) {
  84.             $this->loadResourceForBlockNameHierarchy($cacheKey, $view, $blockNameHierarchy, $hierarchyLevel);
  85.         }
  87.         return $this->resources[$cacheKey][$blockName];
  88.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, $hierarchyLevel)
  94.     {
  95.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  96.         $blockName = $blockNameHierarchy[$hierarchyLevel];
  98.         if (!isset($this->resources[$cacheKey][$blockName])) {
  99.             $this->loadResourceForBlockNameHierarchy($cacheKey, $view, $blockNameHierarchy, $hierarchyLevel);
  100.         }
  102.         // If $block was previously rendered loaded with loadTemplateForBlock(), the template
  103.         // is cached but the hierarchy level is not. In this case, we know that the  block
  104.         // exists at this very hierarchy level, so we can just set it.
  105.         if (!isset($this->resourceHierarchyLevels[$cacheKey][$blockName])) {
  106.             $this->resourceHierarchyLevels[$cacheKey][$blockName] = $hierarchyLevel;
  107.         }
  109.         return $this->resourceHierarchyLevels[$cacheKey][$blockName];
  110.     }
  112.     /**
  113.      * Loads the cache with the resource for a given block name.
  114.      *
  115.      * @see getResourceForBlock()
  116.      *
  117.      * @param string   $cacheKey  The cache key of the form view
  118.      * @param FormView $view      The form view for finding the applying themes
  119.      * @param string   $blockName The name of the block to load
  120.      *
  121.      * @return bool True if the resource could be loaded, false otherwise
  122.      */
  123.     abstract protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName);
  125.     /**
  126.      * Loads the cache with the resource for a specific level of a block hierarchy.
  127.      *
  128.      * @see getResourceForBlockHierarchy()
  129.      */
  130.     private function loadResourceForBlockNameHierarchy(string $cacheKey, FormView $view, array $blockNameHierarchy, $hierarchyLevel): bool
  131.     {
  132.         $blockName = $blockNameHierarchy[$hierarchyLevel];
  134.         // Try to find a template for that block
  135.         if ($this->loadResourceForBlockName($cacheKey, $view, $blockName)) {
  136.             // If loadTemplateForBlock() returns true, it was able to populate the
  137.             // cache. The only missing thing is to set the hierarchy level at which
  138.             // the template was found.
  139.             $this->resourceHierarchyLevels[$cacheKey][$blockName] = $hierarchyLevel;
  141.             return true;
  142.         }
  144.         if ($hierarchyLevel > 0) {
  145.             $parentLevel = $hierarchyLevel - 1;
  146.             $parentBlockName = $blockNameHierarchy[$parentLevel];
  148.             // The next two if statements contain slightly duplicated code. This is by intention
  149.             // and tries to avoid execution of unnecessary checks in order to increase performance.
  151.             if (isset($this->resources[$cacheKey][$parentBlockName])) {
  152.                 // It may happen that the parent block is already loaded, but its level is not.
  153.                 // In this case, the parent block must have been loaded by loadResourceForBlock(),
  154.                 // which does not check the hierarchy of the block. Subsequently the block must have
  155.                 // been found directly on the parent level.
  156.                 if (!isset($this->resourceHierarchyLevels[$cacheKey][$parentBlockName])) {
  157.                     $this->resourceHierarchyLevels[$cacheKey][$parentBlockName] = $parentLevel;
  158.                 }
  160.                 // Cache the shortcuts for further accesses
  161.                 $this->resources[$cacheKey][$blockName] = $this->resources[$cacheKey][$parentBlockName];
  162.                 $this->resourceHierarchyLevels[$cacheKey][$blockName] = $this->resourceHierarchyLevels[$cacheKey][$parentBlockName];
  164.                 return true;
  165.             }
  167.             if ($this->loadResourceForBlockNameHierarchy($cacheKey, $view, $blockNameHierarchy, $parentLevel)) {
  168.                 // Cache the shortcuts for further accesses
  169.                 $this->resources[$cacheKey][$blockName] = $this->resources[$cacheKey][$parentBlockName];
  170.                 $this->resourceHierarchyLevels[$cacheKey][$blockName] = $this->resourceHierarchyLevels[$cacheKey][$parentBlockName];
  172.                 return true;
  173.             }
  174.         }
  176.         // Cache the result for further accesses
  177.         $this->resources[$cacheKey][$blockName] = false;
  178.         $this->resourceHierarchyLevels[$cacheKey][$blockName] = false;
  180.         return false;
  181.     }
  182. }