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

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\Loader\AbstractChoiceLoader;
  16. use Symfony\Component\Form\Exception\LogicException;
  18. /**
  19.  * Loads choices using a Doctrine object manager.
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  */
  23. class DoctrineChoiceLoader extends AbstractChoiceLoader
  24. {
  25.     private $manager;
  26.     private string $class;
  27.     private $idReader;
  28.     private $objectLoader;
  30.     /**
  31.      * Creates a new choice loader.
  32.      *
  33.      * Optionally, an implementation of {@link EntityLoaderInterface} can be
  34.      * passed which optimizes the object loading for one of the Doctrine
  35.      * mapper implementations.
  36.      *
  37.      * @param string $class The class name of the loaded objects
  38.      */
  39.     public function __construct(ObjectManager $manager, string $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)
  40.     {
  41.         $classMetadata = $manager->getClassMetadata($class);
  43.         if ($idReader && !$idReader->isSingleId()) {
  44.             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__));
  45.         }
  47.         $this->manager = $manager;
  48.         $this->class = $classMetadata->getName();
  49.         $this->idReader = $idReader;
  50.         $this->objectLoader = $objectLoader;
  51.     }
  53.     /**
  54.      * {@inheritdoc}
  55.      */
  56.     protected function loadChoices(): iterable
  57.     {
  58.         return $this->objectLoader
  59.             ? $this->objectLoader->getEntities()
  60.             : $this->manager->getRepository($this->class)->findAll();
  61.     }
  63.     /**
  64.      * @internal to be remove in Symfony 6
  65.      */
  66.     protected function doLoadValuesForChoices(array $choices): array
  67.     {
  68.         // Optimize performance for single-field identifiers. We already
  69.         // know that the IDs are used as values
  70.         // Attention: This optimization does not check choices for existence
  71.         if ($this->idReader) {
  72.             throw new LogicException('Not defining the IdReader explicitly as a value callback when the query can be optimized is not supported.');
  73.         }
  75.         return parent::doLoadValuesForChoices($choices);
  76.     }
  78.     protected function doLoadChoicesForValues(array $values, ?callable $value): array
  79.     {
  80.         if ($this->idReader && null === $value) {
  81.             throw new LogicException('Not defining the IdReader explicitly as a value callback when the query can be optimized is not supported.');
  82.         }
  84.         $idReader = null;
  85.         if (\is_array($value) && $value[0] instanceof IdReader) {
  86.             $idReader = $value[0];
  87.         } elseif ($value instanceof \Closure && ($rThis = (new \ReflectionFunction($value))->getClosureThis()) instanceof IdReader) {
  88.             $idReader = $rThis;
  89.         }
  91.         // Optimize performance in case we have an object loader and
  92.         // a single-field identifier
  93.         if ($idReader && $this->objectLoader) {
  94.             $objects = [];
  95.             $objectsById = [];
  97.             // Maintain order and indices from the given $values
  98.             // An alternative approach to the following loop is to add the
  99.             // "INDEX BY" clause to the Doctrine query in the loader,
  100.             // but I'm not sure whether that's doable in a generic fashion.
  101.             foreach ($this->objectLoader->getEntitiesByIds($idReader->getIdField(), $values) as $object) {
  102.                 $objectsById[$idReader->getIdValue($object)] = $object;
  103.             }
  105.             foreach ($values as $i => $id) {
  106.                 if (isset($objectsById[$id])) {
  107.                     $objects[$i] = $objectsById[$id];
  108.                 }
  109.             }
  111.             return $objects;
  112.         }
  114.         return parent::doLoadChoicesForValues($values, $value);
  115.     }
  116. }