vendor/doctrine/mongodb-odm/src/Mapping/LegacyReflectionFields.php line 57

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ODM\MongoDB\Mapping;
  7. use ArrayAccess;
  8. use Countable;
  9. use Doctrine\ODM\MongoDB\Mapping\PropertyAccessors\ReflectionReadonlyProperty;
  10. use Doctrine\Persistence\Mapping\ReflectionService;
  11. use Doctrine\Persistence\Reflection\EnumReflectionProperty;
  12. use Generator;
  13. use IteratorAggregate;
  14. use OutOfBoundsException;
  15. use ReflectionProperty;
  16. use Traversable;
  18. use function array_keys;
  19. use function assert;
  20. use function count;
  21. use function trigger_deprecation;
  23. /**
  24. * @internal
  25. *
  26. * @template-implements ArrayAccess<string, ReflectionProperty|null>
  27. * @template-implements IteratorAggregate<string, ReflectionProperty|null>
  28. */
  29. class LegacyReflectionFields implements ArrayAccess, IteratorAggregate, Countable
  30. {
  31. /** @var array<string, ReflectionProperty|null> */
  32. private array $reflFields = [];
  34. public function __construct(private ClassMetadata $classMetadata, private ReflectionService $reflectionService)
  35. {
  36. }
  38. /** @param string $offset */
  39. public function offsetExists($offset): bool // phpcs:ignore
  40. {
  41. trigger_deprecation('doctrine/mongodb-odm', '2.14', 'Access to ClassMetadata::$reflFields is deprecated and will be removed in Doctrine ODM 3.0.');
  43. return isset($this->classMetadata->propertyAccessors[$offset]);
  44. }
  46. /**
  47. * @param string $field
  48. *
  49. * @psalm-suppress LessSpecificImplementedReturnType
  50. */
  51. public function offsetGet($field): mixed // phpcs:ignore
  52. {
  53. if (isset($this->reflFields[$field])) {
  54. return $this->reflFields[$field];
  55. }
  57. trigger_deprecation('doctrine/mongodb-odm', '2.14', 'Access to ClassMetadata::$reflFields is deprecated and will be removed in Doctrine ODM 3.0.');
  59. if (! isset($this->classMetadata->propertyAccessors[$field])) {
  60. throw new OutOfBoundsException('Unknown field: ' . $this->classMetadata->name . ' ::$' . $field);
  61. }
  63. $className = $this->classMetadata->fieldMappings[$field]['inherited']
  64. ?? $this->classMetadata->fieldMappings[$field]['declared']
  65. ?? $this->classMetadata->associationMappings[$field]['declared']
  66. ?? $this->classMetadata->name;
  68. $this->reflFields[$field] = $this->getAccessibleProperty($className, $field);
  70. if (isset($this->classMetadata->fieldMappings[$field])) {
  71. if ($this->classMetadata->fieldMappings[$field]['enumType'] ?? null) {
  72. $this->reflFields[$field] = new EnumReflectionProperty(
  73. $this->reflFields[$field],
  74. $this->classMetadata->fieldMappings[$field]['enumType'],
  75. );
  76. }
  77. }
  79. return $this->reflFields[$field];
  80. }
  82. /**
  83. * @param string $offset
  84. * @param ReflectionProperty $value
  85. */
  86. public function offsetSet($offset, $value): void // phpcs:ignore
  87. {
  88. $this->reflFields[$offset] = $value;
  89. }
  91. /** @param string $offset */
  92. public function offsetUnset($offset): void // phpcs:ignore
  93. {
  94. unset($this->reflFields[$offset]);
  95. }
  97. /** @psalm-param class-string $class */
  98. private function getAccessibleProperty(string $class, string $field): ReflectionProperty
  99. {
  100. $reflectionProperty = $this->reflectionService->getAccessibleProperty($class, $field);
  102. assert($reflectionProperty !== null);
  104. if ($reflectionProperty->isReadOnly()) {
  105. $declaringClass = $reflectionProperty->class;
  106. if ($declaringClass !== $class) {
  107. $reflectionProperty = $this->reflectionService->getAccessibleProperty($declaringClass, $field);
  109. assert($reflectionProperty !== null);
  110. }
  112. $reflectionProperty = new ReflectionReadonlyProperty($reflectionProperty);
  113. }
  115. return $reflectionProperty;
  116. }
  118. /** @return Generator<string, ReflectionProperty> */
  119. public function getIterator(): Traversable
  120. {
  121. trigger_deprecation('doctrine/mongodb-odm', '2.14', 'Access to ClassMetadata::$reflFields is deprecated and will be removed in Doctrine ODM 3.0.');
  123. $keys = array_keys($this->classMetadata->propertyAccessors);
  125. foreach ($keys as $key) {
  126. yield $key => $this->offsetGet($key);
  127. }
  128. }
  130. public function count(): int
  131. {
  132. trigger_deprecation('doctrine/mongodb-odm', '2.14', 'Access to ClassMetadata::$reflFields is deprecated and will be removed in Doctrine ODM 3.0.');
  134. return count($this->classMetadata->propertyAccessors);
  135. }
  136. }