vendor/doctrine/doctrine-bundle/Repository/ContainerRepositoryFactory.php line 39

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\Mapping\ClassMetadata;
  8. use Doctrine\ORM\Repository\RepositoryFactory;
  9. use Doctrine\Persistence\ObjectRepository;
  10. use Psr\Container\ContainerInterface;
  11. use RuntimeException;
  13. use function class_exists;
  14. use function is_a;
  15. use function spl_object_hash;
  16. use function sprintf;
  18. /**
  19. * Fetches repositories from the container or falls back to normal creation.
  20. */
  21. final class ContainerRepositoryFactory implements RepositoryFactory
  22. {
  23. /** @var array<string, ObjectRepository> */
  24. private array $managedRepositories = [];
  26. private ContainerInterface $container;
  28. /** @param ContainerInterface $container A service locator containing the repositories */
  29. public function __construct(ContainerInterface $container)
  30. {
  31. $this->container = $container;
  32. }
  34. /**
  35. * {@inheritdoc}
  36. *
  37. * @template T of object
  38. */
  39. public function getRepository(EntityManagerInterface $entityManager, $entityName): ObjectRepository
  40. {
  41. $metadata = $entityManager->getClassMetadata($entityName);
  42. $repositoryServiceId = $metadata->customRepositoryClassName;
  44. $customRepositoryName = $metadata->customRepositoryClassName;
  45. if ($customRepositoryName !== null) {
  46. // fetch from the container
  47. if ($this->container->has($customRepositoryName)) {
  48. $repository = $this->container->get($customRepositoryName);
  50. if (! $repository instanceof ObjectRepository) {
  51. throw new RuntimeException(sprintf('The service "%s" must implement ObjectRepository (or extend a base class, like ServiceEntityRepository).', $repositoryServiceId));
  52. }
  54. /** @psalm-var ObjectRepository<T> */
  55. return $repository;
  56. }
  58. // if not in the container but the class/id implements the interface, throw an error
  59. if (is_a($customRepositoryName, ServiceEntityRepositoryInterface::class, true)) {
  60. 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));
  61. }
  63. if (! class_exists($customRepositoryName)) {
  64. 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));
  65. }
  67. // allow the repository to be created below
  68. }
  70. return $this->getOrCreateRepository($entityManager, $metadata);
  71. }
  73. /**
  74. * @param ClassMetadata<TEntity> $metadata
  75. *
  76. * @return ObjectRepository<TEntity>
  77. *
  78. * @template TEntity of object
  79. */
  80. private function getOrCreateRepository(
  81. EntityManagerInterface $entityManager,
  82. ClassMetadata $metadata
  83. ): ObjectRepository {
  84. $repositoryHash = $metadata->getName() . spl_object_hash($entityManager);
  85. if (isset($this->managedRepositories[$repositoryHash])) {
  86. /** @psalm-var ObjectRepository<TEntity> */
  87. return $this->managedRepositories[$repositoryHash];
  88. }
  90. $repositoryClassName = $metadata->customRepositoryClassName ?: $entityManager->getConfiguration()->getDefaultRepositoryClassName();
  92. /** @psalm-var ObjectRepository<TEntity> */
  93. return $this->managedRepositories[$repositoryHash] = new $repositoryClassName($entityManager, $metadata);
  94. }
  95. }