vendor/doctrine/doctrine-bundle/src/Repository/ContainerRepositoryFactory.php line 47

Open in your IDE?
  1. <?php
  3. namespace Doctrine\Bundle\DoctrineBundle\Repository;
  5. use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\ServiceRepositoryCompilerPass;
  6. use Doctrine\ORM\EntityManagerInterface;
  7. use Doctrine\ORM\EntityRepository;
  8. use Doctrine\ORM\Mapping\ClassMetadata;
  9. use Doctrine\ORM\Repository\RepositoryFactory;
  10. use Doctrine\Persistence\ObjectRepository;
  11. use Psr\Container\ContainerInterface;
  12. use RuntimeException;
  14. use function class_exists;
  15. use function get_debug_type;
  16. use function is_a;
  17. use function spl_object_hash;
  18. use function sprintf;
  19. use function trigger_deprecation;
  21. /**
  22. * Fetches repositories from the container or falls back to normal creation.
  23. */
  24. final class ContainerRepositoryFactory implements RepositoryFactory
  25. {
  26. use RepositoryFactoryCompatibility;
  28. /** @var array<string, ObjectRepository> */
  29. private array $managedRepositories = [];
  31. private ContainerInterface $container;
  33. /** @param ContainerInterface $container A service locator containing the repositories */
  34. public function __construct(ContainerInterface $container)
  35. {
  36. $this->container = $container;
  37. }
  39. /**
  40. * @param class-string<T> $entityName
  41. *
  42. * @return ObjectRepository<T>
  43. * @phpstan-return ($strictTypeCheck is true ? EntityRepository<T> : ObjectRepository<T>)
  44. *
  45. * @template T of object
  46. */
  47. private function doGetRepository(EntityManagerInterface $entityManager, string $entityName, bool $strictTypeCheck): ObjectRepository
  48. {
  49. $metadata = $entityManager->getClassMetadata($entityName);
  50. $repositoryServiceId = $metadata->customRepositoryClassName;
  52. $customRepositoryName = $metadata->customRepositoryClassName;
  53. if ($customRepositoryName !== null) {
  54. // fetch from the container
  55. if ($this->container->has($customRepositoryName)) {
  56. $repository = $this->container->get($customRepositoryName);
  58. if (! $repository instanceof EntityRepository && $strictTypeCheck) {
  59. throw new RuntimeException(sprintf('The service "%s" must extend EntityRepository (e.g. by extending ServiceEntityRepository), "%s" given.', $repositoryServiceId, get_debug_type($repository)));
  60. }
  62. if (! $repository instanceof ObjectRepository) {
  63. throw new RuntimeException(sprintf('The service "%s" must implement ObjectRepository (or extend a base class, like ServiceEntityRepository), "%s" given.', $repositoryServiceId, get_debug_type($repository)));
  64. }
  66. if (! $repository instanceof EntityRepository) {
  67. trigger_deprecation('doctrine/doctrine-bundle', '2.11', 'The service "%s" of type "%s" should extend "%s", not doing so is deprecated.', $repositoryServiceId, get_debug_type($repository), EntityRepository::class);
  68. }
  70. /** @phpstan-var ObjectRepository<T> */
  71. return $repository;
  72. }
  74. // if not in the container but the class/id implements the interface, throw an error
  75. if (is_a($customRepositoryName, ServiceEntityRepositoryInterface::class, true)) {
  76. throw new RuntimeException(sprintf('The "%s" entity repository implements "%s", but its service could not be found. Make sure the service exists and is tagged with "%s".', $customRepositoryName, ServiceEntityRepositoryInterface::class, ServiceRepositoryCompilerPass::REPOSITORY_SERVICE_TAG));
  77. }
  79. if (! class_exists($customRepositoryName)) {
  80. throw new RuntimeException(sprintf('The "%s" entity has a repositoryClass set to "%s", but this is not a valid class. Check your class naming. If this is meant to be a service id, make sure this service exists and is tagged with "%s".', $metadata->name, $customRepositoryName, ServiceRepositoryCompilerPass::REPOSITORY_SERVICE_TAG));
  81. }
  83. // allow the repository to be created below
  84. }
  86. return $this->getOrCreateRepository($entityManager, $metadata);
  87. }
  89. /**
  90. * @param ClassMetadata<TEntity> $metadata
  91. *
  92. * @return ObjectRepository<TEntity>
  93. *
  94. * @template TEntity of object
  95. */
  96. private function getOrCreateRepository(
  97. EntityManagerInterface $entityManager,
  98. ClassMetadata $metadata
  99. ): ObjectRepository {
  100. $repositoryHash = $metadata->getName() . spl_object_hash($entityManager);
  101. if (isset($this->managedRepositories[$repositoryHash])) {
  102. /** @phpstan-var ObjectRepository<TEntity> */
  103. return $this->managedRepositories[$repositoryHash];
  104. }
  106. $repositoryClassName = $metadata->customRepositoryClassName ?: $entityManager->getConfiguration()->getDefaultRepositoryClassName();
  108. /** @phpstan-var ObjectRepository<TEntity> */
  109. return $this->managedRepositories[$repositoryHash] = new $repositoryClassName($entityManager, $metadata);
  110. }
  111. }