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

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\Loader\ChoiceLoaderInterface;
  18. /**
  19.  * Loads choices using a Doctrine object manager.
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  */
  23. class DoctrineChoiceLoader implements ChoiceLoaderInterface
  24. {
  25.     private $manager;
  26.     private $class;
  27.     private $idReader;
  28.     private $objectLoader;
  30.     /**
  31.      * @var array|null
  32.      */
  33.     private $choices;
  35.     /**
  36.      * Creates a new choice loader.
  37.      *
  38.      * Optionally, an implementation of {@link EntityLoaderInterface} can be
  39.      * passed which optimizes the object loading for one of the Doctrine
  40.      * mapper implementations.
  41.      *
  42.      * @param string $class The class name of the loaded objects
  43.      */
  44.     public function __construct(ObjectManager $manager, string $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)
  45.     {
  46.         $classMetadata = $manager->getClassMetadata($class);
  48.         if ($idReader && !$idReader->isSingleId()) {
  49.             @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);
  51.             // In Symfony 5.0
  52.             // 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__));
  53.         }
  55.         if ((5 > \func_num_args() || false !== func_get_arg(4)) && null === $idReader) {
  56.             $idReader = new IdReader($manager, $classMetadata);
  58.             if ($idReader->isSingleId()) {
  59.                 @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);
  60.             } else {
  61.                 $idReader = null;
  62.             }
  63.         }
  65.         $this->manager = $manager;
  66.         $this->class = $classMetadata->getName();
  67.         $this->idReader = $idReader;
  68.         $this->objectLoader = $objectLoader;
  69.     }
  71.     /**
  72.      * {@inheritdoc}
  73.      */
  74.     public function loadChoiceList($value = null)
  75.     {
  76.         if (null === $this->choices) {
  77.             $this->choices = $this->objectLoader
  78.                 ? $this->objectLoader->getEntities()
  79.                 : $this->manager->getRepository($this->class)->findAll();
  80.         }
  82.         return new ArrayChoiceList($this->choices, $value);
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function loadValuesForChoices(array $choices, $value = null)
  89.     {
  90.         // Performance optimization
  91.         if (empty($choices)) {
  92.             return [];
  93.         }
  95.         // Optimize performance for single-field identifiers. We already
  96.         // know that the IDs are used as values
  97.         $optimize = $this->idReader && (null === $value || \is_array($value) && $value[0] === $this->idReader);
  99.         // Attention: This optimization does not check choices for existence
  100.         if ($optimize && !$this->choices && $this->idReader->isSingleId()) {
  101.             $values = [];
  103.             // Maintain order and indices of the given objects
  104.             foreach ($choices as $i => $object) {
  105.                 if ($object instanceof $this->class) {
  106.                     // Make sure to convert to the right format
  107.                     $values[$i] = (string) $this->idReader->getIdValue($object);
  108.                 }
  109.             }
  111.             return $values;
  112.         }
  114.         return $this->loadChoiceList($value)->getValuesForChoices($choices);
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     public function loadChoicesForValues(array $values, $value = null)
  121.     {
  122.         // Performance optimization
  123.         // Also prevents the generation of "WHERE id IN ()" queries through the
  124.         // object loader. At least with MySQL and on the development machine
  125.         // this was tested on, no exception was thrown for such invalid
  126.         // statements, consequently no test fails when this code is removed.
  127.         // https://github.com/symfony/symfony/pull/8981#issuecomment-24230557
  128.         if (empty($values)) {
  129.             return [];
  130.         }
  132.         // Optimize performance in case we have an object loader and
  133.         // a single-field identifier
  134.         $optimize = $this->idReader && (null === $value || \is_array($value) && $this->idReader === $value[0]);
  136.         if ($optimize && !$this->choices && $this->objectLoader && $this->idReader->isSingleId()) {
  137.             $unorderedObjects = $this->objectLoader->getEntitiesByIds($this->idReader->getIdField(), $values);
  138.             $objectsById = [];
  139.             $objects = [];
  141.             // Maintain order and indices from the given $values
  142.             // An alternative approach to the following loop is to add the
  143.             // "INDEX BY" clause to the Doctrine query in the loader,
  144.             // but I'm not sure whether that's doable in a generic fashion.
  145.             foreach ($unorderedObjects as $object) {
  146.                 $objectsById[(string) $this->idReader->getIdValue($object)] = $object;
  147.             }
  149.             foreach ($values as $i => $id) {
  150.                 if (isset($objectsById[$id])) {
  151.                     $objects[$i] = $objectsById[$id];
  152.                 }
  153.             }
  155.             return $objects;
  156.         }
  158.         return $this->loadChoiceList($value)->getChoicesForValues($values);
  159.     }
  160. }