vendor/api-platform/core/src/Core/Bridge/Doctrine/Orm/SubresourceDataProvider.php line 67

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\Common\Util\IdentifierManagerTrait;
  17. use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface as LegacyQueryCollectionExtensionInterface;
  18. use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface as LegacyQueryItemExtensionInterface;
  19. use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface as LegacyQueryResultCollectionExtensionInterface;
  20. use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface as LegacyQueryResultItemExtensionInterface;
  21. use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
  22. use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
  23. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  24. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  25. use ApiPlatform\Doctrine\Orm\Extension\FilterEagerLoadingExtension;
  26. use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
  27. use ApiPlatform\Doctrine\Orm\Extension\QueryItemExtensionInterface;
  28. use ApiPlatform\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
  29. use ApiPlatform\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
  30. use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
  31. use ApiPlatform\Exception\ResourceClassNotSupportedException;
  32. use ApiPlatform\Exception\RuntimeException;
  33. use Doctrine\ORM\EntityManagerInterface;
  34. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  35. use Doctrine\ORM\QueryBuilder;
  36. use Doctrine\Persistence\ManagerRegistry;
  38. /**
  39. * Subresource data provider for the Doctrine ORM.
  40. *
  41. * @author Antoine Bluchet <soyuka@gmail.com>
  42. */
  43. final class SubresourceDataProvider implements SubresourceDataProviderInterface
  44. {
  45. use IdentifierManagerTrait;
  47. private $managerRegistry;
  48. private $collectionExtensions;
  49. private $itemExtensions;
  51. /**
  52. * @param LegacyQueryCollectionExtensionInterface[]|QueryCollectionExtensionInterface[] $collectionExtensions
  53. * @param LegacyQueryItemExtensionInterface[]|QueryItemExtensionInterface[] $itemExtensions
  54. */
  55. public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $collectionExtensions = [], iterable $itemExtensions = [])
  56. {
  57. $this->managerRegistry = $managerRegistry;
  58. $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
  59. $this->propertyMetadataFactory = $propertyMetadataFactory;
  60. $this->collectionExtensions = $collectionExtensions;
  61. $this->itemExtensions = $itemExtensions;
  62. }
  64. /**
  65. * @throws RuntimeException
  66. */
  67. public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null)
  68. {
  69. $manager = $this->managerRegistry->getManagerForClass($resourceClass);
  70. if (null === $manager) {
  71. throw new ResourceClassNotSupportedException(sprintf('The object manager associated with the "%s" resource class cannot be retrieved.', $resourceClass));
  72. }
  74. $repository = $manager->getRepository($resourceClass);
  75. if (!method_exists($repository, 'createQueryBuilder')) {
  76. throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
  77. }
  79. if (!isset($context['identifiers'], $context['property'])) {
  80. throw new ResourceClassNotSupportedException('The given resource class is not a subresource.');
  81. }
  83. $queryNameGenerator = new QueryNameGenerator();
  85. /*
  86. * The following recursively translates to this pseudo-dql:
  87. *
  88. * SELECT thirdLevel WHERE thirdLevel IN (
  89. * SELECT thirdLevel FROM relatedDummies WHERE relatedDummies = ? AND relatedDummies IN (
  90. * SELECT relatedDummies FROM Dummy WHERE Dummy = ?
  91. * )
  92. * )
  93. *
  94. * By using subqueries, we're forcing the SQL execution plan to go through indexes on doctrine identifiers.
  95. */
  96. $queryBuilder = $this->buildQuery($identifiers, $context, $queryNameGenerator, $repository->createQueryBuilder($alias = 'o'), $alias, \count($context['identifiers']));
  98. if (true === $context['collection']) {
  99. foreach ($this->collectionExtensions as $extension) {
  100. // We don't need this anymore because we already made sub queries to ensure correct results
  101. if ($extension instanceof FilterEagerLoadingExtension) {
  102. continue;
  103. }
  105. if ($extension instanceof LegacyQueryCollectionExtensionInterface) {
  106. $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context); // @phpstan-ignore-line see context aware
  107. } elseif ($extension instanceof QueryCollectionExtensionInterface) {
  108. $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $context['operation'] ?? null, $context);
  109. }
  111. if ($extension instanceof LegacyQueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { // @phpstan-ignore-line see context aware
  112. return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); // @phpstan-ignore-line see context aware
  113. }
  115. if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $context['operation'] ?? null, $context)) {
  116. return $extension->getResult($queryBuilder, $resourceClass, $context['operation'] ?? null, $context);
  117. }
  118. }
  119. } else {
  120. foreach ($this->itemExtensions as $extension) {
  121. if ($extension instanceof LegacyQueryItemExtensionInterface) {
  122. $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context);
  123. } elseif ($extension instanceof QueryItemExtensionInterface) {
  124. $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $context['operation'] ?? null, $context);
  125. }
  127. if ($extension instanceof LegacyQueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { // @phpstan-ignore-line see context aware
  128. return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); // @phpstan-ignore-line see context aware
  129. }
  131. if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $context['operation'] ?? null, $context)) {
  132. return $extension->getResult($queryBuilder, $resourceClass, $context['operation'], $context);
  133. }
  134. }
  135. }
  137. $query = $queryBuilder->getQuery();
  139. return $context['collection'] ? $query->getResult() : $query->getOneOrNullResult();
  140. }
  142. /**
  143. * @throws RuntimeException
  144. */
  145. private function buildQuery(array $identifiers, array $context, QueryNameGenerator $queryNameGenerator, QueryBuilder $previousQueryBuilder, string $previousAlias, int $remainingIdentifiers, QueryBuilder $topQueryBuilder = null): QueryBuilder
  146. {
  147. if ($remainingIdentifiers <= 0) {
  148. return $previousQueryBuilder;
  149. }
  151. $topQueryBuilder = $topQueryBuilder ?? $previousQueryBuilder;
  153. if (\is_string(key($context['identifiers']))) {
  154. $contextIdentifiers = array_keys($context['identifiers']);
  155. $identifier = $contextIdentifiers[$remainingIdentifiers - 1];
  156. $identifierResourceClass = $context['identifiers'][$identifier][0];
  157. $previousAssociationProperty = $contextIdentifiers[$remainingIdentifiers] ?? $context['property'];
  158. } else {
  159. @trigger_error('Identifiers should match the convention introduced in ADR 0001-resource-identifiers, this behavior will be removed in 3.0.', \E_USER_DEPRECATED);
  160. [$identifier, $identifierResourceClass] = $context['identifiers'][$remainingIdentifiers - 1];
  161. $previousAssociationProperty = $context['identifiers'][$remainingIdentifiers][0] ?? $context['property'];
  162. }
  164. $manager = $this->managerRegistry->getManagerForClass($identifierResourceClass);
  166. if (!$manager instanceof EntityManagerInterface) {
  167. throw new RuntimeException("The manager for $identifierResourceClass must be an EntityManager.");
  168. }
  170. $classMetadata = $manager->getClassMetadata($identifierResourceClass);
  172. if (!$classMetadata instanceof ClassMetadataInfo) {
  173. throw new RuntimeException("The class metadata for $identifierResourceClass must be an instance of ClassMetadataInfo.");
  174. }
  176. $qb = $manager->createQueryBuilder();
  177. $alias = $queryNameGenerator->generateJoinAlias($identifier);
  178. $normalizedIdentifiers = [];
  180. if (isset($identifiers[$identifier])) {
  181. // if it's an array it's already normalized, the IdentifierManagerTrait is deprecated
  182. if ($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false) {
  183. $normalizedIdentifiers = $identifiers[$identifier];
  184. } else {
  185. $normalizedIdentifiers = $this->normalizeIdentifiers($identifiers[$identifier], $manager, $identifierResourceClass);
  186. }
  187. }
  189. if ($classMetadata->hasAssociation($previousAssociationProperty)) {
  190. $relationType = $classMetadata->getAssociationMapping($previousAssociationProperty)['type'];
  191. switch ($relationType) {
  192. // MANY_TO_MANY relations need an explicit join so that the identifier part can be retrieved
  193. case ClassMetadataInfo::MANY_TO_MANY:
  194. $joinAlias = $queryNameGenerator->generateJoinAlias($previousAssociationProperty);
  196. $qb->select($joinAlias)
  197. ->from($identifierResourceClass, $alias)
  198. ->innerJoin("$alias.$previousAssociationProperty", $joinAlias);
  199. break;
  200. case ClassMetadataInfo::ONE_TO_MANY:
  201. $mappedBy = $classMetadata->getAssociationMapping($previousAssociationProperty)['mappedBy'];
  202. $previousAlias = "$previousAlias.$mappedBy";
  204. $qb->select($alias)
  205. ->from($identifierResourceClass, $alias);
  206. break;
  207. case ClassMetadataInfo::ONE_TO_ONE:
  208. $association = $classMetadata->getAssociationMapping($previousAssociationProperty);
  209. if (!isset($association['mappedBy'])) {
  210. $qb->select("IDENTITY($alias.$previousAssociationProperty)")
  211. ->from($identifierResourceClass, $alias);
  212. break;
  213. }
  214. $mappedBy = $association['mappedBy'];
  215. $previousAlias = "$previousAlias.$mappedBy";
  217. $qb->select($alias)
  218. ->from($identifierResourceClass, $alias);
  219. break;
  220. default:
  221. $qb->select("IDENTITY($alias.$previousAssociationProperty)")
  222. ->from($identifierResourceClass, $alias);
  223. }
  224. } elseif ($classMetadata->isIdentifier($previousAssociationProperty)) {
  225. $qb->select($alias)
  226. ->from($identifierResourceClass, $alias);
  227. }
  229. $isLeaf = 1 === $remainingIdentifiers;
  231. // Add where clause for identifiers
  232. foreach ($normalizedIdentifiers as $key => $value) {
  233. $placeholder = $queryNameGenerator->generateParameterName($key);
  234. $topQueryBuilder->setParameter($placeholder, $value, (string) $classMetadata->getTypeOfField($key));
  236. // Optimization: add where clause for identifiers, but not via a WHERE ... IN ( ...subquery... ).
  237. // Instead we use a direct identifier equality clause, to speed things up when dealing with large tables.
  238. // We may do so if there is no more recursion levels from here, and if relation allows it.
  239. $association = $classMetadata->hasAssociation($previousAssociationProperty) ? $classMetadata->getAssociationMapping($previousAssociationProperty) : [];
  240. $oneToOneBidirectional = isset($association['inversedBy']) && ClassMetadataInfo::ONE_TO_ONE === $association['type'];
  241. $oneToManyBidirectional = isset($association['mappedBy']) && ClassMetadataInfo::ONE_TO_MANY === $association['type'];
  242. if ($isLeaf && $oneToOneBidirectional) {
  243. $joinAlias = $queryNameGenerator->generateJoinAlias($association['inversedBy']);
  245. return $previousQueryBuilder->innerJoin("$previousAlias.{$association['inversedBy']}", $joinAlias)
  246. ->andWhere("$joinAlias.$key = :$placeholder");
  247. }
  248. if ($isLeaf && $oneToManyBidirectional && \in_array($key, $classMetadata->getIdentifier(), true)) {
  249. return $previousQueryBuilder->andWhere("IDENTITY($previousAlias) = :$placeholder");
  250. }
  252. $qb->andWhere("$alias.$key = :$placeholder");
  253. }
  255. // Recurse queries
  256. $qb = $this->buildQuery($identifiers, $context, $queryNameGenerator, $qb, $alias, --$remainingIdentifiers, $topQueryBuilder);
  258. return $previousQueryBuilder->andWhere($qb->expr()->in($previousAlias, $qb->getDQL()));
  259. }
  260. }