vendor/symfony/form/ChoiceList/Factory/CachingFactoryDecorator.php line 118

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\ChoiceList\Factory;
  14. use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
  15. use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
  16. use Symfony\Component\Form\ChoiceList\View\ChoiceListView;
  17. use Symfony\Contracts\Service\ResetInterface;
  19. /**
  20.  * Caches the choice lists created by the decorated factory.
  21.  *
  22.  * @author Bernhard Schussek <bschussek@gmail.com>
  23.  */
  24. class CachingFactoryDecorator implements ChoiceListFactoryInterface, ResetInterface
  25. {
  26.     private $decoratedFactory;
  28.     /**
  29.      * @var ChoiceListInterface[]
  30.      */
  31.     private $lists = [];
  33.     /**
  34.      * @var ChoiceListView[]
  35.      */
  36.     private $views = [];
  38.     /**
  39.      * Generates a SHA-256 hash for the given value.
  40.      *
  41.      * Optionally, a namespace string can be passed. Calling this method will
  42.      * the same values, but different namespaces, will return different hashes.
  43.      *
  44.      * @param mixed $value The value to hash
  45.      *
  46.      * @return string The SHA-256 hash
  47.      *
  48.      * @internal
  49.      */
  50.     public static function generateHash($value, string $namespace = ''): string
  51.     {
  52.         if (\is_object($value)) {
  53.             $value = spl_object_hash($value);
  54.         } elseif (\is_array($value)) {
  55.             array_walk_recursive($value, function (&$v) {
  56.                 if (\is_object($v)) {
  57.                     $v = spl_object_hash($v);
  58.                 }
  59.             });
  60.         }
  62.         return hash('sha256', $namespace.':'.serialize($value));
  63.     }
  65.     public function __construct(ChoiceListFactoryInterface $decoratedFactory)
  66.     {
  67.         $this->decoratedFactory = $decoratedFactory;
  68.     }
  70.     /**
  71.      * Returns the decorated factory.
  72.      *
  73.      * @return ChoiceListFactoryInterface The decorated factory
  74.      */
  75.     public function getDecoratedFactory()
  76.     {
  77.         return $this->decoratedFactory;
  78.     }
  80.     /**
  81.      * {@inheritdoc}
  82.      */
  83.     public function createListFromChoices(iterable $choices, $value = null)
  84.     {
  85.         if ($choices instanceof \Traversable) {
  86.             $choices = iterator_to_array($choices);
  87.         }
  89.         // The value is not validated on purpose. The decorated factory may
  90.         // decide which values to accept and which not.
  92.         $hash = self::generateHash([$choices, $value], 'fromChoices');
  94.         if (!isset($this->lists[$hash])) {
  95.             $this->lists[$hash] = $this->decoratedFactory->createListFromChoices($choices, $value);
  96.         }
  98.         return $this->lists[$hash];
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function createListFromLoader(ChoiceLoaderInterface $loader, $value = null)
  105.     {
  106.         $hash = self::generateHash([$loader, $value], 'fromLoader');
  108.         if (!isset($this->lists[$hash])) {
  109.             $this->lists[$hash] = $this->decoratedFactory->createListFromLoader($loader, $value);
  110.         }
  112.         return $this->lists[$hash];
  113.     }
  115.     /**
  116.      * {@inheritdoc}
  117.      */
  118.     public function createView(ChoiceListInterface $list, $preferredChoices = null, $label = null, $index = null, $groupBy = null, $attr = null)
  119.     {
  120.         // The input is not validated on purpose. This way, the decorated
  121.         // factory may decide which input to accept and which not.
  122.         $hash = self::generateHash([$list, $preferredChoices, $label, $index, $groupBy, $attr]);
  124.         if (!isset($this->views[$hash])) {
  125.             $this->views[$hash] = $this->decoratedFactory->createView(
  126.                 $list,
  127.                 $preferredChoices,
  128.                 $label,
  129.                 $index,
  130.                 $groupBy,
  131.                 $attr
  132.             );
  133.         }
  135.         return $this->views[$hash];
  136.     }
  138.     public function reset()
  139.     {
  140.         $this->lists = [];
  141.         $this->views = [];
  142.     }
  143. }