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 readonly bool $singleId;
  28. private readonly bool $intId;
  29. private readonly string $idField;
  30. private readonly ?self $associationIdReader;
  32. public function __construct(
  33. private readonly ObjectManager $om,
  34. private readonly ClassMetadata $classMetadata,
  35. ) {
  36. $ids = $classMetadata->getIdentifierFieldNames();
  37. $idType = $classMetadata->getTypeOfField(current($ids));
  39. $singleId = 1 === \count($ids);
  40. $this->idField = current($ids);
  42. // single field association are resolved, since the schema column could be an int
  43. if ($singleId && $classMetadata->hasAssociation($this->idField)) {
  44. $this->associationIdReader = new self($om, $om->getClassMetadata(
  45. $classMetadata->getAssociationTargetClass($this->idField)
  46. ));
  48. $singleId = $this->associationIdReader->isSingleId();
  49. $this->intId = $this->associationIdReader->isIntId();
  50. } else {
  51. $this->intId = $singleId && \in_array($idType, ['integer', 'smallint', 'bigint']);
  52. $this->associationIdReader = null;
  53. }
  55. $this->singleId = $singleId;
  56. }
  58. /**
  59. * Returns whether the class has a single-column ID.
  60. */
  61. public function isSingleId(): bool
  62. {
  63. return $this->singleId;
  64. }
  66. /**
  67. * Returns whether the class has a single-column integer ID.
  68. */
  69. public function isIntId(): bool
  70. {
  71. return $this->intId;
  72. }
  74. /**
  75. * Returns the ID value for an object.
  76. *
  77. * This method assumes that the object has a single-column ID.
  78. */
  79. public function getIdValue(?object $object = null): string
  80. {
  81. if (!$object) {
  82. return '';
  83. }
  85. if (!$this->om->contains($object)) {
  86. 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)));
  87. }
  89. $this->om->initializeObject($object);
  91. $idValue = current($this->classMetadata->getIdentifierValues($object));
  93. if ($this->associationIdReader) {
  94. $idValue = $this->associationIdReader->getIdValue($idValue);
  95. }
  97. return (string) $idValue;
  98. }
  100. /**
  101. * Returns the name of the ID field.
  102. *
  103. * This method assumes that the object has a single-column ID.
  104. */
  105. public function getIdField(): string
  106. {
  107. return $this->idField;
  108. }
  109. }