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

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <[email protected]>
  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;
  17. /**
  18. * Loads choices using a Doctrine object manager.
  19. *
  20. * @author Bernhard Schussek <[email protected]>
  21. */
  22. class DoctrineChoiceLoader extends AbstractChoiceLoader
  23. {
  24. private $manager;
  25. private $class;
  26. private $idReader;
  27. private $objectLoader;
  29. /**
  30. * Creates a new choice loader.
  31. *
  32. * Optionally, an implementation of {@link EntityLoaderInterface} can be
  33. * passed which optimizes the object loading for one of the Doctrine
  34. * mapper implementations.
  35. *
  36. * @param string $class The class name of the loaded objects
  37. */
  38. public function __construct(ObjectManager $manager, string $class, ?IdReader $idReader = null, ?EntityLoaderInterface $objectLoader = null)
  39. {
  40. $classMetadata = $manager->getClassMetadata($class);
  42. if ($idReader && !$idReader->isSingleId()) {
  43. throw new \InvalidArgumentException(sprintf('The `$idReader` argument of "%s" must be null when the query cannot be optimized because of composite id fields.', __METHOD__));
  44. }
  46. $this->manager = $manager;
  47. $this->class = $classMetadata->getName();
  48. $this->idReader = $idReader;
  49. $this->objectLoader = $objectLoader;
  50. }
  52. /**
  53. * {@inheritdoc}
  54. */
  55. protected function loadChoices(): iterable
  56. {
  57. return $this->objectLoader
  58. ? $this->objectLoader->getEntities()
  59. : $this->manager->getRepository($this->class)->findAll();
  60. }
  62. /**
  63. * @internal to be remove in Symfony 6
  64. */
  65. protected function doLoadValuesForChoices(array $choices): array
  66. {
  67. // Optimize performance for single-field identifiers. We already
  68. // know that the IDs are used as values
  69. // Attention: This optimization does not check choices for existence
  70. if ($this->idReader) {
  71. trigger_deprecation('symfony/doctrine-bridge', '5.1', 'Not defining explicitly the IdReader as value callback when query can be optimized is deprecated. Don\'t pass the IdReader to "%s" or define the "choice_value" option instead.', __CLASS__);
  72. // Maintain order and indices of the given objects
  73. $values = [];
  74. foreach ($choices as $i => $object) {
  75. if ($object instanceof $this->class) {
  76. $values[$i] = $this->idReader->getIdValue($object);
  77. }
  78. }
  80. return $values;
  81. }
  83. return parent::doLoadValuesForChoices($choices);
  84. }
  86. protected function doLoadChoicesForValues(array $values, ?callable $value): array
  87. {
  88. $legacy = $this->idReader && null === $value;
  90. if ($legacy) {
  91. trigger_deprecation('symfony/doctrine-bridge', '5.1', 'Not defining explicitly the IdReader as value callback when query can be optimized is deprecated. Don\'t pass the IdReader to "%s" or define the "choice_value" option instead.', __CLASS__);
  92. }
  94. $idReader = null;
  95. if (\is_array($value) && $value[0] instanceof IdReader) {
  96. $idReader = $value[0];
  97. } elseif ($value instanceof \Closure && ($rThis = (new \ReflectionFunction($value))->getClosureThis()) instanceof IdReader) {
  98. $idReader = $rThis;
  99. } elseif ($legacy) {
  100. $idReader = $this->idReader;
  101. }
  103. // Optimize performance in case we have an object loader and
  104. // a single-field identifier
  105. if ($idReader && $this->objectLoader) {
  106. $objects = [];
  107. $objectsById = [];
  109. // Maintain order and indices from the given $values
  110. // An alternative approach to the following loop is to add the
  111. // "INDEX BY" clause to the Doctrine query in the loader,
  112. // but I'm not sure whether that's doable in a generic fashion.
  113. foreach ($this->objectLoader->getEntitiesByIds($idReader->getIdField(), $values) as $object) {
  114. $objectsById[$idReader->getIdValue($object)] = $object;
  115. }
  117. foreach ($values as $i => $id) {
  118. if (isset($objectsById[$id])) {
  119. $objects[$i] = $objectsById[$id];
  120. }
  121. }
  123. return $objects;
  124. }
  126. return parent::doLoadChoicesForValues($values, $value);
  127. }
  128. }