vendor/symfony/doctrine-bridge/Form/ChoiceList/DoctrineChoiceLoader.php line 24

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\Bridge\Doctrine\Form\ChoiceList;
  14. use Doctrine\Persistence\ObjectManager;
  15. use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
  16. use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
  17. use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
  19. /**
  20.  * Loads choices using a Doctrine object manager.
  21.  *
  22.  * @author Bernhard Schussek <bschussek@gmail.com>
  23.  */
  24. class DoctrineChoiceLoader implements ChoiceLoaderInterface
  25. {
  26.     private $manager;
  27.     private $class;
  28.     private $idReader;
  29.     private $objectLoader;
  31.     /**
  32.      * @var ChoiceListInterface
  33.      */
  34.     private $choiceList;
  36.     /**
  37.      * Creates a new choice loader.
  38.      *
  39.      * Optionally, an implementation of {@link EntityLoaderInterface} can be
  40.      * passed which optimizes the object loading for one of the Doctrine
  41.      * mapper implementations.
  42.      *
  43.      * @param string                     $class        The class name of the loaded objects
  44.      * @param IdReader                   $idReader     The reader for the object IDs
  45.      * @param EntityLoaderInterface|null $objectLoader The objects loader
  46.      */
  47.     public function __construct(ObjectManager $manager, string $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)
  48.     {
  49.         $classMetadata = $manager->getClassMetadata($class);
  51.         if ($idReader && !$idReader->isSingleId()) {
  52.             @trigger_error(sprintf('Passing an instance of "%s" to "%s" with an entity class "%s" that has a composite id is deprecated since Symfony 4.3 and will throw an exception in 5.0.', IdReader::class, __CLASS__, $class), E_USER_DEPRECATED);
  54.             // In Symfony 5.0
  55.             // throw new \InvalidArgumentException(sprintf('The second argument `$idReader` of "%s" must be null when the query cannot be optimized because of composite id fields.', __METHOD__));
  56.         }
  58.         if ((5 > \func_num_args() || false !== func_get_arg(4)) && null === $idReader) {
  59.             $idReader = new IdReader($manager, $classMetadata);
  61.             if ($idReader->isSingleId()) {
  62.                 @trigger_error(sprintf('Not explicitly passing an instance of "%s" to "%s" when it can optimize single id entity "%s" has been deprecated in 4.3 and will not apply any optimization in 5.0.', IdReader::class, __CLASS__, $class), E_USER_DEPRECATED);
  63.             } else {
  64.                 $idReader = null;
  65.             }
  66.         }
  68.         $this->manager = $manager;
  69.         $this->class = $classMetadata->getName();
  70.         $this->idReader = $idReader;
  71.         $this->objectLoader = $objectLoader;
  72.     }
  74.     /**
  75.      * {@inheritdoc}
  76.      */
  77.     public function loadChoiceList($value = null)
  78.     {
  79.         if ($this->choiceList) {
  80.             return $this->choiceList;
  81.         }
  83.         $objects = $this->objectLoader
  84.             ? $this->objectLoader->getEntities()
  85.             : $this->manager->getRepository($this->class)->findAll();
  87.         return $this->choiceList = new ArrayChoiceList($objects, $value);
  88.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function loadValuesForChoices(array $choices, $value = null)
  94.     {
  95.         // Performance optimization
  96.         if (empty($choices)) {
  97.             return [];
  98.         }
  100.         // Optimize performance for single-field identifiers. We already
  101.         // know that the IDs are used as values
  102.         $optimize = $this->idReader && (null === $value || \is_array($value) && $value[0] === $this->idReader);
  104.         // Attention: This optimization does not check choices for existence
  105.         if ($optimize && !$this->choiceList && $this->idReader->isSingleId()) {
  106.             $values = [];
  108.             // Maintain order and indices of the given objects
  109.             foreach ($choices as $i => $object) {
  110.                 if ($object instanceof $this->class) {
  111.                     // Make sure to convert to the right format
  112.                     $values[$i] = (string) $this->idReader->getIdValue($object);
  113.                 }
  114.             }
  116.             return $values;
  117.         }
  119.         return $this->loadChoiceList($value)->getValuesForChoices($choices);
  120.     }
  122.     /**
  123.      * {@inheritdoc}
  124.      */
  125.     public function loadChoicesForValues(array $values, $value = null)
  126.     {
  127.         // Performance optimization
  128.         // Also prevents the generation of "WHERE id IN ()" queries through the
  129.         // object loader. At least with MySQL and on the development machine
  130.         // this was tested on, no exception was thrown for such invalid
  131.         // statements, consequently no test fails when this code is removed.
  132.         // https://github.com/symfony/symfony/pull/8981#issuecomment-24230557
  133.         if (empty($values)) {
  134.             return [];
  135.         }
  137.         // Optimize performance in case we have an object loader and
  138.         // a single-field identifier
  139.         $optimize = $this->idReader && (null === $value || \is_array($value) && $this->idReader === $value[0]);
  141.         if ($optimize && !$this->choiceList && $this->objectLoader && $this->idReader->isSingleId()) {
  142.             $unorderedObjects = $this->objectLoader->getEntitiesByIds($this->idReader->getIdField(), $values);
  143.             $objectsById = [];
  144.             $objects = [];
  146.             // Maintain order and indices from the given $values
  147.             // An alternative approach to the following loop is to add the
  148.             // "INDEX BY" clause to the Doctrine query in the loader,
  149.             // but I'm not sure whether that's doable in a generic fashion.
  150.             foreach ($unorderedObjects as $object) {
  151.                 $objectsById[(string) $this->idReader->getIdValue($object)] = $object;
  152.             }
  154.             foreach ($values as $i => $id) {
  155.                 if (isset($objectsById[$id])) {
  156.                     $objects[$i] = $objectsById[$id];
  157.                 }
  158.             }
  160.             return $objects;
  161.         }
  163.         return $this->loadChoiceList($value)->getChoicesForValues($values);
  164.     }
  165. }