vendor/symfony/form/AbstractRendererEngine.php line 78

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