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.      */
  45.     public function __construct(ObjectManager $manager, string $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)
  46.     {
  47.         $classMetadata = $manager->getClassMetadata($class);
  49.         if ($idReader && !$idReader->isSingleId()) {
  50.             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__));
  51.         }
  53.         $this->manager = $manager;
  54.         $this->class = $classMetadata->getName();
  55.         $this->idReader = $idReader;
  56.         $this->objectLoader = $objectLoader;
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public function loadChoiceList(callable $value = null)
  63.     {
  64.         if ($this->choiceList) {
  65.             return $this->choiceList;
  66.         }
  68.         $objects = $this->objectLoader
  69.             ? $this->objectLoader->getEntities()
  70.             : $this->manager->getRepository($this->class)->findAll();
  72.         return $this->choiceList = new ArrayChoiceList($objects, $value);
  73.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      */
  78.     public function loadValuesForChoices(array $choices, callable $value = null)
  79.     {
  80.         // Performance optimization
  81.         if (empty($choices)) {
  82.             return [];
  83.         }
  85.         // Optimize performance for single-field identifiers. We already
  86.         // know that the IDs are used as values
  87.         $optimize = $this->idReader && (null === $value || \is_array($value) && $value[0] === $this->idReader);
  89.         // Attention: This optimization does not check choices for existence
  90.         if ($optimize && !$this->choiceList) {
  91.             $values = [];
  93.             // Maintain order and indices of the given objects
  94.             foreach ($choices as $i => $object) {
  95.                 if ($object instanceof $this->class) {
  96.                     // Make sure to convert to the right format
  97.                     $values[$i] = (string) $this->idReader->getIdValue($object);
  98.                 }
  99.             }
  101.             return $values;
  102.         }
  104.         return $this->loadChoiceList($value)->getValuesForChoices($choices);
  105.     }
  107.     /**
  108.      * {@inheritdoc}
  109.      */
  110.     public function loadChoicesForValues(array $values, callable $value = null)
  111.     {
  112.         // Performance optimization
  113.         // Also prevents the generation of "WHERE id IN ()" queries through the
  114.         // object loader. At least with MySQL and on the development machine
  115.         // this was tested on, no exception was thrown for such invalid
  116.         // statements, consequently no test fails when this code is removed.
  117.         // https://github.com/symfony/symfony/pull/8981#issuecomment-24230557
  118.         if (empty($values)) {
  119.             return [];
  120.         }
  122.         // Optimize performance in case we have an object loader and
  123.         // a single-field identifier
  124.         $optimize = $this->idReader && (null === $value || \is_array($value) && $this->idReader === $value[0]);
  126.         if ($optimize && !$this->choiceList && $this->objectLoader) {
  127.             $unorderedObjects = $this->objectLoader->getEntitiesByIds($this->idReader->getIdField(), $values);
  128.             $objectsById = [];
  129.             $objects = [];
  131.             // Maintain order and indices from the given $values
  132.             // An alternative approach to the following loop is to add the
  133.             // "INDEX BY" clause to the Doctrine query in the loader,
  134.             // but I'm not sure whether that's doable in a generic fashion.
  135.             foreach ($unorderedObjects as $object) {
  136.                 $objectsById[(string) $this->idReader->getIdValue($object)] = $object;
  137.             }
  139.             foreach ($values as $i => $id) {
  140.                 if (isset($objectsById[$id])) {
  141.                     $objects[$i] = $objectsById[$id];
  142.                 }
  143.             }
  145.             return $objects;
  146.         }
  148.         return $this->loadChoiceList($value)->getChoicesForValues($values);
  149.     }
  150. }