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

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\Common\Persistence\Mapping\ClassMetadata;
  15. use Doctrine\Common\Persistence\ObjectManager;
  16. use Symfony\Component\Form\Exception\RuntimeException;
  18. /**
  19.  * A utility for reading object IDs.
  20.  *
  21.  * @author Bernhard Schussek <[email protected]>
  22.  *
  23.  * @internal
  24.  */
  25. class IdReader
  26. {
  27.     private $om;
  28.     private $classMetadata;
  29.     private $singleId;
  30.     private $intId;
  31.     private $idField;
  33.     /**
  34.      * @var IdReader|null
  35.      */
  36.     private $associationIdReader;
  38.     public function __construct(ObjectManager $om, ClassMetadata $classMetadata)
  39.     {
  40.         $ids = $classMetadata->getIdentifierFieldNames();
  41.         $idType = $classMetadata->getTypeOfField(current($ids));
  43.         $this->om = $om;
  44.         $this->classMetadata = $classMetadata;
  45.         $this->singleId = 1 === \count($ids);
  46.         $this->intId = $this->singleId && \in_array($idType, ['integer', 'smallint', 'bigint']);
  47.         $this->idField = current($ids);
  49.         // single field association are resolved, since the schema column could be an int
  50.         if ($this->singleId && $classMetadata->hasAssociation($this->idField)) {
  51.             $this->associationIdReader = new self($om, $om->getClassMetadata(
  52.                 $classMetadata->getAssociationTargetClass($this->idField)
  53.             ));
  55.             $this->singleId = $this->associationIdReader->isSingleId();
  56.             $this->intId = $this->associationIdReader->isIntId();
  57.         }
  58.     }
  60.     /**
  61.      * Returns whether the class has a single-column ID.
  62.      *
  63.      * @return bool returns `true` if the class has a single-column ID and
  64.      *              `false` otherwise
  65.      */
  66.     public function isSingleId(): bool
  67.     {
  68.         return $this->singleId;
  69.     }
  71.     /**
  72.      * Returns whether the class has a single-column integer ID.
  73.      *
  74.      * @return bool returns `true` if the class has a single-column integer ID
  75.      *              and `false` otherwise
  76.      */
  77.     public function isIntId(): bool
  78.     {
  79.         return $this->intId;
  80.     }
  82.     /**
  83.      * Returns the ID value for an object.
  84.      *
  85.      * This method assumes that the object has a single-column ID.
  86.      *
  87.      * @param object $object The object
  88.      *
  89.      * @return mixed The ID value
  90.      */
  91.     public function getIdValue($object)
  92.     {
  93.         if (!$object) {
  94.             return null;
  95.         }
  97.         if (!$this->om->contains($object)) {
  98.             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_class($object)));
  99.         }
  101.         $this->om->initializeObject($object);
  103.         $idValue = current($this->classMetadata->getIdentifierValues($object));
  105.         if ($this->associationIdReader) {
  106.             $idValue = $this->associationIdReader->getIdValue($idValue);
  107.         }
  109.         return $idValue;
  110.     }
  112.     /**
  113.      * Returns the name of the ID field.
  114.      *
  115.      * This method assumes that the object has a single-column ID.
  116.      *
  117.      * @return string The name of the ID field
  118.      */
  119.     public function getIdField(): string
  120.     {
  121.         return $this->idField;
  122.     }
  123. }