vendor/sonata-project/admin-bundle/src/Form/ChoiceList/ModelChoiceLoader.php line 27

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\AdminBundle\Form\ChoiceList;
  16. use Sonata\AdminBundle\Model\ModelManagerInterface;
  17. use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
  18. use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
  19. use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
  20. use Symfony\Component\Form\Exception\InvalidArgumentException;
  21. use Symfony\Component\Form\Exception\TransformationFailedException;
  22. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  24. /**
  25.  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  26.  */
  27. final class ModelChoiceLoader implements ChoiceLoaderInterface
  28. {
  29.     private ?ChoiceListInterface $choiceList = null;
  31.     /**
  32.      * @param ModelManagerInterface<object> $modelManager
  33.      * @param object[]|null                 $choices
  34.      *
  35.      * @phpstan-param class-string $class
  36.      */
  37.     public function __construct(
  38.         private ModelManagerInterface $modelManager,
  39.         private PropertyAccessorInterface $propertyAccessor,
  40.         private string $class,
  41.         private ?string $property = null,
  42.         private ?object $query = null,
  43.         private ?array $choices = null,
  44.     ) {
  45.         if (null !== $query && !$this->modelManager->supportsQuery($query)) {
  46.             throw new InvalidArgumentException('The model manager does not support the query.');
  47.         }
  48.     }
  50.     public function loadChoiceList($value = null): ChoiceListInterface
  51.     {
  52.         if (null === $this->choiceList) {
  53.             if (null !== $this->query) {
  54.                 $entities = $this->modelManager->executeQuery($this->query);
  55.             } elseif (\is_array($this->choices)) {
  56.                 $entities = $this->choices;
  57.             } else {
  58.                 $entities = $this->modelManager->findBy($this->class);
  59.             }
  61.             $choices = [];
  62.             foreach ($entities as $model) {
  63.                 if (null !== $this->property) {
  64.                     // If the property option was given, use it
  65.                     $valueObject = $this->propertyAccessor->getValue($model, $this->property);
  66.                 } elseif (method_exists($model, '__toString')) {
  67.                     // Otherwise expect a __toString() method in the entity
  68.                     $valueObject = (string) $model;
  69.                 } else {
  70.                     throw new TransformationFailedException(\sprintf(
  71.                         'Unable to convert the model "%s" to string, provide "property" option'
  72.                         .' or implement "__toString()" method in your model.',
  73.                         $this->class
  74.                     ));
  75.                 }
  77.                 if (!\array_key_exists($valueObject, $choices)) {
  78.                     $choices[$valueObject] = [];
  79.                 }
  81.                 $identifier = $this->modelManager->getNormalizedIdentifier($model);
  82.                 if (null === $identifier) {
  83.                     throw new TransformationFailedException(\sprintf(
  84.                         'No identifier was found for the model "%s".',
  85.                         $this->class
  86.                     ));
  87.                 }
  89.                 $choices[$valueObject][] = $identifier;
  90.             }
  92.             $finalChoices = [];
  93.             foreach ($choices as $valueObject => $idx) {
  94.                 if (\count($idx) > 1) { // avoid issue with identical values ...
  95.                     foreach ($idx as $id) {
  96.                         $finalChoices[\sprintf('%s (id: %s)', $valueObject, $id)] = $id;
  97.                     }
  98.                 } else {
  99.                     $finalChoices[$valueObject] = current($idx);
  100.                 }
  101.             }
  103.             $this->choiceList = new ArrayChoiceList($finalChoices, $value);
  104.         }
  106.         return $this->choiceList;
  107.     }
  109.     public function loadChoicesForValues(array $values, $value = null): array
  110.     {
  111.         return $this->loadChoiceList($value)->getChoicesForValues($values);
  112.     }
  114.     public function loadValuesForChoices(array $choices, $value = null): array
  115.     {
  116.         return $this->loadChoiceList($value)->getValuesForChoices($choices);
  117.     }
  118. }