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

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 $managedRepositories = [];
  26. /** @var ContainerInterface */
  27. private $container;
  29. /** @param ContainerInterface $container A service locator containing the repositories */
  30. public function __construct(ContainerInterface $container)
  31. {
  32. $this->container = $container;
  33. }
  35. /**
  36. * {@inheritdoc}
  37. *
  38. * @template T of object
  39. */
  40. public function getRepository(EntityManagerInterface $entityManager, $entityName): ObjectRepository
  41. {
  42. $metadata = $entityManager->getClassMetadata($entityName);
  43. $repositoryServiceId = $metadata->customRepositoryClassName;
  45. $customRepositoryName = $metadata->customRepositoryClassName;
  46. if ($customRepositoryName !== null) {
  47. // fetch from the container
  48. if ($this->container->has($customRepositoryName)) {
  49. $repository = $this->container->get($customRepositoryName);
  51. if (! $repository instanceof ObjectRepository) {
  52. throw new RuntimeException(sprintf('The service "%s" must implement ObjectRepository (or extend a base class, like ServiceEntityRepository).', $repositoryServiceId));
  53. }
  55. /** @psalm-var ObjectRepository<T> */
  56. return $repository;
  57. }
  59. // if not in the container but the class/id implements the interface, throw an error
  60. if (is_a($customRepositoryName, ServiceEntityRepositoryInterface::class, true)) {
  61. 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));
  62. }
  64. if (! class_exists($customRepositoryName)) {
  65. 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));
  66. }
  68. // allow the repository to be created below
  69. }
  71. return $this->getOrCreateRepository($entityManager, $metadata);
  72. }
  74. /**
  75. * @param ClassMetadata<TEntity> $metadata
  76. *
  77. * @return ObjectRepository<TEntity>
  78. *
  79. * @template TEntity of object
  80. */
  81. private function getOrCreateRepository(
  82. EntityManagerInterface $entityManager,
  83. ClassMetadata $metadata
  84. ): ObjectRepository {
  85. $repositoryHash = $metadata->getName() . spl_object_hash($entityManager);
  86. if (isset($this->managedRepositories[$repositoryHash])) {
  87. /** @psalm-var ObjectRepository<TEntity> */
  88. return $this->managedRepositories[$repositoryHash];
  89. }
  91. $repositoryClassName = $metadata->customRepositoryClassName ?: $entityManager->getConfiguration()->getDefaultRepositoryClassName();
  93. /** @psalm-var ObjectRepository<TEntity> */
  94. return $this->managedRepositories[$repositoryHash] = new $repositoryClassName($entityManager, $metadata);
  95. }
  96. }