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

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 Doctrine\Common\Util\ClassUtils;
  17. use Sonata\AdminBundle\Model\ModelManagerInterface;
  18. use Sonata\Doctrine\Adapter\AdapterInterface;
  19. use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
  20. use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
  21. use Symfony\Component\Form\Exception\RuntimeException;
  22. use Symfony\Component\PropertyAccess\PropertyAccess;
  23. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  24. use Symfony\Component\PropertyAccess\PropertyPath;
  26. /**
  27.  * @final since sonata-project/admin-bundle 3.52
  28.  *
  29.  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  30.  */
  31. class ModelChoiceLoader implements ChoiceLoaderInterface
  32. {
  33.     public $identifier;
  35.     /**
  36.      * @var \Sonata\AdminBundle\Model\ModelManagerInterface
  37.      */
  38.     private $modelManager;
  40.     /**
  41.      * @var string
  42.      */
  43.     private $class;
  45.     private $property;
  47.     private $query;
  49.     private $choices;
  51.     /**
  52.      * @var PropertyPath
  53.      */
  54.     private $propertyPath;
  56.     /**
  57.      * @var PropertyAccessorInterface
  58.      */
  59.     private $propertyAccessor;
  61.     private $choiceList;
  63.     /**
  64.      * @param string      $class
  65.      * @param string|null $property
  66.      * @param mixed|null  $query
  67.      * @param array       $choices
  68.      */
  69.     public function __construct(
  70.         ModelManagerInterface $modelManager,
  71.         $class,
  72.         $property = null,
  73.         $query = null,
  74.         $choices = [],
  75.         ?PropertyAccessorInterface $propertyAccessor = null
  76.     ) {
  77.         $this->modelManager = $modelManager;
  78.         $this->class = $class;
  79.         $this->property = $property;
  80.         $this->query = $query;
  81.         $this->choices = $choices;
  83.         $this->identifier = $this->modelManager->getIdentifierFieldNames($this->class);
  85.         // The property option defines, which property (path) is used for
  86.         // displaying entities as strings
  87.         if ($property) {
  88.             $this->propertyPath = new PropertyPath($property);
  89.             $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
  90.         }
  91.     }
  93.     public function loadChoiceList($value = null)
  94.     {
  95.         if (!$this->choiceList) {
  96.             if ($this->query) {
  97.                 $entities = $this->modelManager->executeQuery($this->query);
  98.             } elseif (\is_array($this->choices) && \count($this->choices) > 0) {
  99.                 $entities = $this->choices;
  100.             } else {
  101.                 $entities = $this->modelManager->findBy($this->class);
  102.             }
  104.             $choices = [];
  105.             foreach ($entities as $key => $entity) {
  106.                 if ($this->propertyPath) {
  107.                     // If the property option was given, use it
  108.                     $valueObject = $this->propertyAccessor->getValue($entity, $this->propertyPath);
  109.                 } else {
  110.                     // Otherwise expect a __toString() method in the entity
  111.                     try {
  112.                         $valueObject = (string) $entity;
  113.                     } catch (\Exception $e) {
  114.                         throw new RuntimeException(sprintf('Unable to convert the entity "%s" to string, provide "property" option or implement "__toString()" method in your entity.', ClassUtils::getClass($entity)), 0, $e);
  115.                     }
  116.                 }
  118.                 $id = implode(AdapterInterface::ID_SEPARATOR, $this->getIdentifierValues($entity));
  120.                 if (!\array_key_exists($valueObject, $choices)) {
  121.                     $choices[$valueObject] = [];
  122.                 }
  124.                 $choices[$valueObject][] = $id;
  125.             }
  127.             $finalChoices = [];
  128.             foreach ($choices as $valueObject => $idx) {
  129.                 if (\count($idx) > 1) { // avoid issue with identical values ...
  130.                     foreach ($idx as $id) {
  131.                         $finalChoices[sprintf('%s (id: %s)', $valueObject, $id)] = $id;
  132.                     }
  133.                 } else {
  134.                     $finalChoices[$valueObject] = current($idx);
  135.                 }
  136.             }
  138.             $this->choiceList = new ArrayChoiceList($finalChoices, $value);
  139.         }
  141.         return $this->choiceList;
  142.     }
  144.     public function loadChoicesForValues(array $values, $value = null)
  145.     {
  146.         return $this->loadChoiceList($value)->getChoicesForValues($values);
  147.     }
  149.     public function loadValuesForChoices(array $choices, $value = null)
  150.     {
  151.         return $this->loadChoiceList($value)->getValuesForChoices($choices);
  152.     }
  154.     /**
  155.      * @param object $entity
  156.      */
  157.     private function getIdentifierValues($entity): array
  158.     {
  159.         try {
  160.             return $this->modelManager->getIdentifierValues($entity);
  161.         } catch (\Exception $e) {
  162.             throw new \InvalidArgumentException(sprintf('Unable to retrieve the identifier values for entity %s', ClassUtils::getClass($entity)), 0, $e);
  163.         }
  164.     }
  165. }