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 <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 $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. public function isSingleId(): bool
  64. {
  65. return $this->singleId;
  66. }
  68. /**
  69. * Returns whether the class has a single-column integer ID.
  70. */
  71. public function isIntId(): bool
  72. {
  73. return $this->intId;
  74. }
  76. /**
  77. * Returns the ID value for an object.
  78. *
  79. * This method assumes that the object has a single-column ID.
  80. */
  81. public function getIdValue(?object $object = null): string
  82. {
  83. if (!$object) {
  84. return '';
  85. }
  87. if (!$this->om->contains($object)) {
  88. 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)));
  89. }
  91. $this->om->initializeObject($object);
  93. $idValue = current($this->classMetadata->getIdentifierValues($object));
  95. if ($this->associationIdReader) {
  96. $idValue = $this->associationIdReader->getIdValue($idValue);
  97. }
  99. return (string) $idValue;
  100. }
  102. /**
  103. * Returns the name of the ID field.
  104. *
  105. * This method assumes that the object has a single-column ID.
  106. */
  107. public function getIdField(): string
  108. {
  109. return $this->idField;
  110. }
  111. }