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

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. * {@inheritdoc}
  66. *
  67. * @throws RuntimeException
  68. */
  69. public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null)
  70. {
  71. $manager = $this->managerRegistry->getManagerForClass($resourceClass);
  72. if (null === $manager) {
  73. throw new ResourceClassNotSupportedException(sprintf('The object manager associated with the "%s" resource class cannot be retrieved.', $resourceClass));
  74. }
  76. $repository = $manager->getRepository($resourceClass);
  77. if (!method_exists($repository, 'createQueryBuilder')) {
  78. throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
  79. }
  81. if (!isset($context['identifiers'], $context['property'])) {
  82. throw new ResourceClassNotSupportedException('The given resource class is not a subresource.');
  83. }
  85. $queryNameGenerator = new QueryNameGenerator();
  87. /*
  88. * The following recursively translates to this pseudo-dql:
  89. *
  90. * SELECT thirdLevel WHERE thirdLevel IN (
  91. * SELECT thirdLevel FROM relatedDummies WHERE relatedDummies = ? AND relatedDummies IN (
  92. * SELECT relatedDummies FROM Dummy WHERE Dummy = ?
  93. * )
  94. * )
  95. *
  96. * By using subqueries, we're forcing the SQL execution plan to go through indexes on doctrine identifiers.
  97. */
  98. $queryBuilder = $this->buildQuery($identifiers, $context, $queryNameGenerator, $repository->createQueryBuilder($alias = 'o'), $alias, \count($context['identifiers']));
  100. if (true === $context['collection']) {
  101. foreach ($this->collectionExtensions as $extension) {
  102. // We don't need this anymore because we already made sub queries to ensure correct results
  103. if ($extension instanceof FilterEagerLoadingExtension) {
  104. continue;
  105. }
  107. if ($extension instanceof LegacyQueryCollectionExtensionInterface) {
  108. $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context); // @phpstan-ignore-line see context aware
  109. } elseif ($extension instanceof QueryCollectionExtensionInterface) {
  110. $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $context['operation'] ?? null, $context);
  111. }
  113. if ($extension instanceof LegacyQueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { // @phpstan-ignore-line see context aware
  114. return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); // @phpstan-ignore-line see context aware
  115. }
  117. if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $context['operation'] ?? null, $context)) {
  118. return $extension->getResult($queryBuilder, $resourceClass, $context['operation'] ?? null, $context);
  119. }
  120. }
  121. } else {
  122. foreach ($this->itemExtensions as $extension) {
  123. if ($extension instanceof LegacyQueryItemExtensionInterface) {
  124. $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context);
  125. } elseif ($extension instanceof QueryItemExtensionInterface) {
  126. $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $context['operation'] ?? null, $context);
  127. }
  129. if ($extension instanceof LegacyQueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { // @phpstan-ignore-line see context aware
  130. return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); // @phpstan-ignore-line see context aware
  131. }
  133. if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $context['operation'] ?? null, $context)) {
  134. return $extension->getResult($queryBuilder, $resourceClass, $context['operation'], $context);
  135. }
  136. }
  137. }
  139. $query = $queryBuilder->getQuery();
  141. return $context['collection'] ? $query->getResult() : $query->getOneOrNullResult();
  142. }
  144. /**
  145. * @throws RuntimeException
  146. */
  147. private function buildQuery(array $identifiers, array $context, QueryNameGenerator $queryNameGenerator, QueryBuilder $previousQueryBuilder, string $previousAlias, int $remainingIdentifiers, QueryBuilder $topQueryBuilder = null): QueryBuilder
  148. {
  149. if ($remainingIdentifiers <= 0) {
  150. return $previousQueryBuilder;
  151. }
  153. $topQueryBuilder = $topQueryBuilder ?? $previousQueryBuilder;
  155. if (\is_string(key($context['identifiers']))) {
  156. $contextIdentifiers = array_keys($context['identifiers']);
  157. $identifier = $contextIdentifiers[$remainingIdentifiers - 1];
  158. $identifierResourceClass = $context['identifiers'][$identifier][0];
  159. $previousAssociationProperty = $contextIdentifiers[$remainingIdentifiers] ?? $context['property'];
  160. } else {
  161. @trigger_error('Identifiers should match the convention introduced in ADR 0001-resource-identifiers, this behavior will be removed in 3.0.', \E_USER_DEPRECATED);
  162. [$identifier, $identifierResourceClass] = $context['identifiers'][$remainingIdentifiers - 1];
  163. $previousAssociationProperty = $context['identifiers'][$remainingIdentifiers][0] ?? $context['property'];
  164. }
  166. $manager = $this->managerRegistry->getManagerForClass($identifierResourceClass);
  168. if (!$manager instanceof EntityManagerInterface) {
  169. throw new RuntimeException("The manager for $identifierResourceClass must be an EntityManager.");
  170. }
  172. $classMetadata = $manager->getClassMetadata($identifierResourceClass);
  174. if (!$classMetadata instanceof ClassMetadataInfo) {
  175. throw new RuntimeException("The class metadata for $identifierResourceClass must be an instance of ClassMetadataInfo.");
  176. }
  178. $qb = $manager->createQueryBuilder();
  179. $alias = $queryNameGenerator->generateJoinAlias($identifier);
  180. $normalizedIdentifiers = [];
  182. if (isset($identifiers[$identifier])) {
  183. // if it's an array it's already normalized, the IdentifierManagerTrait is deprecated
  184. if ($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false) {
  185. $normalizedIdentifiers = $identifiers[$identifier];
  186. } else {
  187. $normalizedIdentifiers = $this->normalizeIdentifiers($identifiers[$identifier], $manager, $identifierResourceClass);
  188. }
  189. }
  191. if ($classMetadata->hasAssociation($previousAssociationProperty)) {
  192. $relationType = $classMetadata->getAssociationMapping($previousAssociationProperty)['type'];
  193. switch ($relationType) {
  194. // MANY_TO_MANY relations need an explicit join so that the identifier part can be retrieved
  195. case ClassMetadataInfo::MANY_TO_MANY:
  196. $joinAlias = $queryNameGenerator->generateJoinAlias($previousAssociationProperty);
  198. $qb->select($joinAlias)
  199. ->from($identifierResourceClass, $alias)
  200. ->innerJoin("$alias.$previousAssociationProperty", $joinAlias);
  201. break;
  202. case ClassMetadataInfo::ONE_TO_MANY:
  203. $mappedBy = $classMetadata->getAssociationMapping($previousAssociationProperty)['mappedBy'];
  204. $previousAlias = "$previousAlias.$mappedBy";
  206. $qb->select($alias)
  207. ->from($identifierResourceClass, $alias);
  208. break;
  209. case ClassMetadataInfo::ONE_TO_ONE:
  210. $association = $classMetadata->getAssociationMapping($previousAssociationProperty);
  211. if (!isset($association['mappedBy'])) {
  212. $qb->select("IDENTITY($alias.$previousAssociationProperty)")
  213. ->from($identifierResourceClass, $alias);
  214. break;
  215. }
  216. $mappedBy = $association['mappedBy'];
  217. $previousAlias = "$previousAlias.$mappedBy";
  219. $qb->select($alias)
  220. ->from($identifierResourceClass, $alias);
  221. break;
  222. default:
  223. $qb->select("IDENTITY($alias.$previousAssociationProperty)")
  224. ->from($identifierResourceClass, $alias);
  225. }
  226. } elseif ($classMetadata->isIdentifier($previousAssociationProperty)) {
  227. $qb->select($alias)
  228. ->from($identifierResourceClass, $alias);
  229. }
  231. $isLeaf = 1 === $remainingIdentifiers;
  233. // Add where clause for identifiers
  234. foreach ($normalizedIdentifiers as $key => $value) {
  235. $placeholder = $queryNameGenerator->generateParameterName($key);
  236. $topQueryBuilder->setParameter($placeholder, $value, (string) $classMetadata->getTypeOfField($key));
  238. // Optimization: add where clause for identifiers, but not via a WHERE ... IN ( ...subquery... ).
  239. // Instead we use a direct identifier equality clause, to speed things up when dealing with large tables.
  240. // We may do so if there is no more recursion levels from here, and if relation allows it.
  241. $association = $classMetadata->hasAssociation($previousAssociationProperty) ? $classMetadata->getAssociationMapping($previousAssociationProperty) : [];
  242. $oneToOneBidirectional = isset($association['inversedBy']) && ClassMetadataInfo::ONE_TO_ONE === $association['type'];
  243. $oneToManyBidirectional = isset($association['mappedBy']) && ClassMetadataInfo::ONE_TO_MANY === $association['type'];
  244. if ($isLeaf && $oneToOneBidirectional) {
  245. $joinAlias = $queryNameGenerator->generateJoinAlias($association['inversedBy']);
  247. return $previousQueryBuilder->innerJoin("$previousAlias.{$association['inversedBy']}", $joinAlias)
  248. ->andWhere("$joinAlias.$key = :$placeholder");
  249. }
  250. if ($isLeaf && $oneToManyBidirectional && \in_array($key, $classMetadata->getIdentifier(), true)) {
  251. return $previousQueryBuilder->andWhere("IDENTITY($previousAlias) = :$placeholder");
  252. }
  254. $qb->andWhere("$alias.$key = :$placeholder");
  255. }
  257. // Recurse queries
  258. $qb = $this->buildQuery($identifiers, $context, $queryNameGenerator, $qb, $alias, --$remainingIdentifiers, $topQueryBuilder);
  260. return $previousQueryBuilder->andWhere($qb->expr()->in($previousAlias, $qb->getDQL()));
  261. }
  262. }