vendor/api-platform/core/src/Core/Bridge/Doctrine/Orm/CollectionDataProvider.php line 49

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the API Platform project.
  5. *
  6. * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Bridge\Doctrine\Orm;
  16. use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface as LegacyQueryCollectionExtensionInterface;
  17. use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface as LegacyQueryResultCollectionExtensionInterface;
  18. use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
  19. use ApiPlatform\Core\DataProvider\ContextAwareCollectionDataProviderInterface;
  20. use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
  21. use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
  22. use ApiPlatform\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
  23. use ApiPlatform\Exception\RuntimeException;
  24. use Doctrine\ORM\EntityManagerInterface;
  25. use Doctrine\Persistence\ManagerRegistry;
  27. /**
  28. * Collection data provider for the Doctrine ORM.
  29. *
  30. * @author Kévin Dunglas <dunglas@gmail.com>
  31. * @author Samuel ROZE <samuel.roze@gmail.com>
  32. *
  33. * @final
  34. */
  35. class CollectionDataProvider implements ContextAwareCollectionDataProviderInterface, RestrictedDataProviderInterface
  36. {
  37. private $managerRegistry;
  38. private $collectionExtensions;
  40. /**
  41. * @param LegacyQueryCollectionExtensionInterface[]|QueryCollectionExtensionInterface[] $collectionExtensions
  42. */
  43. public function __construct(ManagerRegistry $managerRegistry, iterable $collectionExtensions = [])
  44. {
  45. $this->managerRegistry = $managerRegistry;
  46. $this->collectionExtensions = $collectionExtensions;
  47. }
  49. public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
  50. {
  51. return $this->managerRegistry->getManagerForClass($resourceClass) instanceof EntityManagerInterface;
  52. }
  54. /**
  55. * @throws RuntimeException
  56. */
  57. public function getCollection(string $resourceClass, string $operationName = null, array $context = []): iterable
  58. {
  59. /** @var EntityManagerInterface $manager */
  60. $manager = $this->managerRegistry->getManagerForClass($resourceClass);
  62. $repository = $manager->getRepository($resourceClass);
  63. if (!method_exists($repository, 'createQueryBuilder')) {
  64. throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
  65. }
  67. $queryBuilder = $repository->createQueryBuilder('o');
  68. $queryNameGenerator = new QueryNameGenerator();
  69. foreach ($this->collectionExtensions as $extension) {
  70. if ($extension instanceof LegacyQueryCollectionExtensionInterface) {
  71. $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context); // @phpstan-ignore-line because of context
  72. } elseif ($extension instanceof QueryCollectionExtensionInterface) {
  73. $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $context['operation'] ?? null, $context);
  74. }
  76. if ($extension instanceof LegacyQueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { // @phpstan-ignore-line because of context
  77. return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); // @phpstan-ignore-line because of context
  78. }
  80. if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $context['operation'] ?? null, $context)) {
  81. return $extension->getResult($queryBuilder, $resourceClass, $context['operation'] ?? null, $context);
  82. }
  83. }
  85. return $queryBuilder->getQuery()->getResult();
  86. }
  87. }