vendor/symfony/doctrine-bridge/Form/ChoiceList/IdReader.php line 25

  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\Mapping\ClassMetadata;
  15. use Doctrine\Persistence\ObjectManager;
  16. use Symfony\Component\Form\Exception\RuntimeException;
  18. /**
  19.  * A utility for reading object IDs.
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  *
  23.  * @internal
  24.  */
  25. class IdReader
  26. {
  27.     private ObjectManager $om;
  28.     private ClassMetadata $classMetadata;
  29.     private bool $singleId;
  30.     private bool $intId;
  31.     private string $idField;
  32.     private ?self $associationIdReader = null;
  34.     public function __construct(ObjectManager $om, ClassMetadata $classMetadata)
  35.     {
  36.         $ids = $classMetadata->getIdentifierFieldNames();
  37.         $idType = $classMetadata->getTypeOfField(current($ids));
  39.         $this->om = $om;
  40.         $this->classMetadata = $classMetadata;
  41.         $this->singleId = 1 === \count($ids);
  42.         $this->intId = $this->singleId && \in_array($idType, ['integer', 'smallint', 'bigint']);
  43.         $this->idField = current($ids);
  45.         // single field association are resolved, since the schema column could be an int
  46.         if ($this->singleId && $classMetadata->hasAssociation($this->idField)) {
  47.             $this->associationIdReader = new self($om, $om->getClassMetadata(
  48.                 $classMetadata->getAssociationTargetClass($this->idField)
  49.             ));
  51.             $this->singleId = $this->associationIdReader->isSingleId();
  52.             $this->intId = $this->associationIdReader->isIntId();
  53.         }
  54.     }
  56.     /**
  57.      * Returns whether the class has a single-column ID.
  58.      */
  59.     public function isSingleId(): bool
  60.     {
  61.         return $this->singleId;
  62.     }
  64.     /**
  65.      * Returns whether the class has a single-column integer ID.
  66.      */
  67.     public function isIntId(): bool
  68.     {
  69.         return $this->intId;
  70.     }
  72.     /**
  73.      * Returns the ID value for an object.
  74.      *
  75.      * This method assumes that the object has a single-column ID.
  76.      */
  77.     public function getIdValue(object $object = null): string
  78.     {
  79.         if (!$object) {
  80.             return '';
  81.         }
  83.         if (!$this->om->contains($object)) {
  84.             throw new RuntimeException(sprintf('Entity of type "%s" passed to the choice field must be managed. Maybe you forget to persist it in the entity manager?', get_debug_type($object)));
  85.         }
  87.         $this->om->initializeObject($object);
  89.         $idValue = current($this->classMetadata->getIdentifierValues($object));
  91.         if ($this->associationIdReader) {
  92.             $idValue = $this->associationIdReader->getIdValue($idValue);
  93.         }
  95.         return (string) $idValue;
  96.     }
  98.     /**
  99.      * Returns the name of the ID field.
  100.      *
  101.      * This method assumes that the object has a single-column ID.
  102.      */
  103.     public function getIdField(): string
  104.     {
  105.         return $this->idField;
  106.     }
  107. }