vendor/symfony/form/AbstractRendererEngine.php line 87

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 <[email protected]>
  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.     /**
  27.      * @var array
  28.      */
  29.     protected $defaultThemes;
  31.     /**
  32.      * @var array[]
  33.      */
  34.     protected $themes = [];
  36.     /**
  37.      * @var bool[]
  38.      */
  39.     protected $useDefaultThemes = [];
  41.     /**
  42.      * @var array[]
  43.      */
  44.     protected $resources = [];
  46.     /**
  47.      * @var array<array<int|false>>
  48.      */
  49.     private $resourceHierarchyLevels = [];
  51.     /**
  52.      * Creates a new renderer engine.
  53.      *
  54.      * @param array $defaultThemes The default themes. The type of these
  55.      *                             themes is open to the implementation.
  56.      */
  57.     public function __construct(array $defaultThemes = [])
  58.     {
  59.         $this->defaultThemes = $defaultThemes;
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function setTheme(FormView $view, $themes, bool $useDefaultThemes = true)
  66.     {
  67.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  69.         // Do not cast, as casting turns objects into arrays of properties
  70.         $this->themes[$cacheKey] = \is_array($themes) ? $themes : [$themes];
  71.         $this->useDefaultThemes[$cacheKey] = $useDefaultThemes;
  73.         // Unset instead of resetting to an empty array, in order to allow
  74.         // implementations (like TwigRendererEngine) to check whether $cacheKey
  75.         // is set at all.
  76.         unset($this->resources[$cacheKey], $this->resourceHierarchyLevels[$cacheKey]);
  77.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function getResourceForBlockName(FormView $view, string $blockName)
  83.     {
  84.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  86.         if (!isset($this->resources[$cacheKey][$blockName])) {
  87.             $this->loadResourceForBlockName($cacheKey, $view, $blockName);
  88.         }
  90.         return $this->resources[$cacheKey][$blockName];
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public function getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, int $hierarchyLevel)
  97.     {
  98.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  99.         $blockName = $blockNameHierarchy[$hierarchyLevel];
  101.         if (!isset($this->resources[$cacheKey][$blockName])) {
  102.             $this->loadResourceForBlockNameHierarchy($cacheKey, $view, $blockNameHierarchy, $hierarchyLevel);
  103.         }
  105.         return $this->resources[$cacheKey][$blockName];
  106.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     public function getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, int $hierarchyLevel)
  112.     {
  113.         $cacheKey = $view->vars[self::CACHE_KEY_VAR];
  114.         $blockName = $blockNameHierarchy[$hierarchyLevel];
  116.         if (!isset($this->resources[$cacheKey][$blockName])) {
  117.             $this->loadResourceForBlockNameHierarchy($cacheKey, $view, $blockNameHierarchy, $hierarchyLevel);
  118.         }
  120.         // If $block was previously rendered loaded with loadTemplateForBlock(), the template
  121.         // is cached but the hierarchy level is not. In this case, we know that the  block
  122.         // exists at this very hierarchy level, so we can just set it.
  123.         if (!isset($this->resourceHierarchyLevels[$cacheKey][$blockName])) {
  124.             $this->resourceHierarchyLevels[$cacheKey][$blockName] = $hierarchyLevel;
  125.         }
  127.         return $this->resourceHierarchyLevels[$cacheKey][$blockName];
  128.     }
  130.     /**
  131.      * Loads the cache with the resource for a given block name.
  132.      *
  133.      * @see getResourceForBlock()
  134.      *
  135.      * @return bool True if the resource could be loaded, false otherwise
  136.      */
  137.     abstract protected function loadResourceForBlockName(string $cacheKey, FormView $view, string $blockName);
  139.     /**
  140.      * Loads the cache with the resource for a specific level of a block hierarchy.
  141.      *
  142.      * @see getResourceForBlockHierarchy()
  143.      */
  144.     private function loadResourceForBlockNameHierarchy(string $cacheKey, FormView $view, array $blockNameHierarchy, int $hierarchyLevel): bool
  145.     {
  146.         $blockName = $blockNameHierarchy[$hierarchyLevel];
  148.         // Try to find a template for that block
  149.         if ($this->loadResourceForBlockName($cacheKey, $view, $blockName)) {
  150.             // If loadTemplateForBlock() returns true, it was able to populate the
  151.             // cache. The only missing thing is to set the hierarchy level at which
  152.             // the template was found.
  153.             $this->resourceHierarchyLevels[$cacheKey][$blockName] = $hierarchyLevel;
  155.             return true;
  156.         }
  158.         if ($hierarchyLevel > 0) {
  159.             $parentLevel = $hierarchyLevel - 1;
  160.             $parentBlockName = $blockNameHierarchy[$parentLevel];
  162.             // The next two if statements contain slightly duplicated code. This is by intention
  163.             // and tries to avoid execution of unnecessary checks in order to increase performance.
  165.             if (isset($this->resources[$cacheKey][$parentBlockName])) {
  166.                 // It may happen that the parent block is already loaded, but its level is not.
  167.                 // In this case, the parent block must have been loaded by loadResourceForBlock(),
  168.                 // which does not check the hierarchy of the block. Subsequently the block must have
  169.                 // been found directly on the parent level.
  170.                 if (!isset($this->resourceHierarchyLevels[$cacheKey][$parentBlockName])) {
  171.                     $this->resourceHierarchyLevels[$cacheKey][$parentBlockName] = $parentLevel;
  172.                 }
  174.                 // Cache the shortcuts for further accesses
  175.                 $this->resources[$cacheKey][$blockName] = $this->resources[$cacheKey][$parentBlockName];
  176.                 $this->resourceHierarchyLevels[$cacheKey][$blockName] = $this->resourceHierarchyLevels[$cacheKey][$parentBlockName];
  178.                 return true;
  179.             }
  181.             if ($this->loadResourceForBlockNameHierarchy($cacheKey, $view, $blockNameHierarchy, $parentLevel)) {
  182.                 // Cache the shortcuts for further accesses
  183.                 $this->resources[$cacheKey][$blockName] = $this->resources[$cacheKey][$parentBlockName];
  184.                 $this->resourceHierarchyLevels[$cacheKey][$blockName] = $this->resourceHierarchyLevels[$cacheKey][$parentBlockName];
  186.                 return true;
  187.             }
  188.         }
  190.         // Cache the result for further accesses
  191.         $this->resources[$cacheKey][$blockName] = false;
  192.         $this->resourceHierarchyLevels[$cacheKey][$blockName] = false;
  194.         return false;
  195.     }
  196. }