vendor/symfony/symfony/src/Symfony/Component/Form/Extension/Templating/TemplatingRendererEngine.php line 14

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\Extension\Templating;
  14. @trigger_error('The '.TemplatingRendererEngine::class.' class is deprecated since version 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  16. use Symfony\Component\Form\AbstractRendererEngine;
  17. use Symfony\Component\Form\FormView;
  18. use Symfony\Component\Templating\EngineInterface;
  20. /**
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  *
  23.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  24.  */
  25. class TemplatingRendererEngine extends AbstractRendererEngine
  26. {
  27.     private $engine;
  29.     public function __construct(EngineInterface $engine, array $defaultThemes = [])
  30.     {
  31.         parent::__construct($defaultThemes);
  33.         $this->engine = $engine;
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public function renderBlock(FormView $view, $resource, $blockName, array $variables = [])
  40.     {
  41.         return trim($this->engine->render($resource, $variables));
  42.     }
  44.     /**
  45.      * Loads the cache with the resource for a given block name.
  46.      *
  47.      * This implementation tries to load as few blocks as possible, since each block
  48.      * is represented by a template on the file system.
  49.      *
  50.      * @see getResourceForBlock()
  51.      *
  52.      * @param string   $cacheKey  The cache key of the form view
  53.      * @param FormView $view      The form view for finding the applying themes
  54.      * @param string   $blockName The name of the block to load
  55.      *
  56.      * @return bool True if the resource could be loaded, false otherwise
  57.      */
  58.     protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName)
  59.     {
  60.         // Recursively try to find the block in the themes assigned to $view,
  61.         // then of its parent form, then of the parent form of the parent and so on.
  62.         // When the root form is reached in this recursion, also the default
  63.         // themes are taken into account.
  65.         // Check each theme whether it contains the searched block
  66.         if (isset($this->themes[$cacheKey])) {
  67.             for ($i = \count($this->themes[$cacheKey]) - 1; $i >= 0; --$i) {
  68.                 if ($this->loadResourceFromTheme($cacheKey, $blockName, $this->themes[$cacheKey][$i])) {
  69.                     return true;
  70.                 }
  71.             }
  72.         }
  74.         // Check the default themes once we reach the root form without success
  75.         if (!$view->parent) {
  76.             if (!isset($this->useDefaultThemes[$cacheKey]) || $this->useDefaultThemes[$cacheKey]) {
  77.                 for ($i = \count($this->defaultThemes) - 1; $i >= 0; --$i) {
  78.                     if ($this->loadResourceFromTheme($cacheKey, $blockName, $this->defaultThemes[$i])) {
  79.                         return true;
  80.                     }
  81.                 }
  82.             }
  83.         }
  85.         // If we did not find anything in the themes of the current view, proceed
  86.         // with the themes of the parent view
  87.         if ($view->parent) {
  88.             $parentCacheKey = $view->parent->vars[self::CACHE_KEY_VAR];
  90.             if (!isset($this->resources[$parentCacheKey][$blockName])) {
  91.                 $this->loadResourceForBlockName($parentCacheKey, $view->parent, $blockName);
  92.             }
  94.             // If a template exists in the parent themes, cache that template
  95.             // for the current theme as well to speed up further accesses
  96.             if ($this->resources[$parentCacheKey][$blockName]) {
  97.                 $this->resources[$cacheKey][$blockName] = $this->resources[$parentCacheKey][$blockName];
  99.                 return true;
  100.             }
  101.         }
  103.         // Cache that we didn't find anything to speed up further accesses
  104.         $this->resources[$cacheKey][$blockName] = false;
  106.         return false;
  107.     }
  109.     /**
  110.      * Tries to load the resource for a block from a theme.
  111.      *
  112.      * @param string $cacheKey  The cache key for storing the resource
  113.      * @param string $blockName The name of the block to load a resource for
  114.      * @param mixed  $theme     The theme to load the block from
  115.      *
  116.      * @return bool True if the resource could be loaded, false otherwise
  117.      */
  118.     protected function loadResourceFromTheme($cacheKey, $blockName, $theme)
  119.     {
  120.         if ($this->engine->exists($templateName = $theme.':'.$blockName.'.html.php')) {
  121.             $this->resources[$cacheKey][$blockName] = $templateName;
  123.             return true;
  124.         }
  126.         return false;
  127.     }
  128. }