vendor/api-platform/core/src/Core/Bridge/Doctrine/Orm/ItemDataProvider.php line 54

  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\QueryItemExtensionInterface as LegacyQueryItemExtensionInterface;
  18. use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface as LegacyQueryResultItemExtensionInterface;
  19. use ApiPlatform\Core\DataProvider\DenormalizedIdentifiersAwareItemDataProviderInterface;
  20. use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
  21. use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
  22. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  23. use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  24. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  25. use ApiPlatform\Doctrine\Orm\Extension\QueryItemExtensionInterface;
  26. use ApiPlatform\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
  27. use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
  28. use ApiPlatform\Exception\RuntimeException;
  29. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  30. use Doctrine\ORM\EntityManagerInterface;
  31. use Doctrine\ORM\QueryBuilder;
  32. use Doctrine\Persistence\ManagerRegistry;
  33. use Doctrine\Persistence\Mapping\ClassMetadata;
  35. /**
  36.  * Item data provider for the Doctrine ORM.
  37.  *
  38.  * @author Kévin Dunglas <dunglas@gmail.com>
  39.  * @author Samuel ROZE <samuel.roze@gmail.com>
  40.  *
  41.  * @final
  42.  */
  43. class ItemDataProvider implements DenormalizedIdentifiersAwareItemDataProviderInterface, RestrictedDataProviderInterface
  44. {
  45.     use IdentifierManagerTrait;
  47.     private $managerRegistry;
  48.     private $itemExtensions;
  50.     /**
  51.      * @param LegacyQueryItemExtensionInterface[]|QueryItemExtensionInterface[] $itemExtensions
  52.      * @param ResourceMetadataCollectionFactoryInterface|null                   $resourceMetadataFactory
  53.      */
  54.     public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $itemExtensions = [], $resourceMetadataFactory = null)
  55.     {
  56.         $this->managerRegistry = $managerRegistry;
  57.         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
  58.         $this->propertyMetadataFactory = $propertyMetadataFactory;
  60.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  61.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  62.         }
  64.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  65.         $this->itemExtensions = $itemExtensions;
  66.     }
  68.     public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
  69.     {
  70.         return $this->managerRegistry->getManagerForClass($resourceClass) instanceof EntityManagerInterface;
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      *
  76.      * The context may contain a `fetch_data` key representing whether the value should be fetched by Doctrine or if we should return a reference.
  77.      *
  78.      * @throws RuntimeException
  79.      */
  80.     public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
  81.     {
  82.         /** @var EntityManagerInterface $manager */
  83.         $manager = $this->managerRegistry->getManagerForClass($resourceClass);
  85.         if ((\is_int($id) || \is_string($id)) && !($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false)) {
  86.             $id = $this->normalizeIdentifiers($id, $manager, $resourceClass);
  87.         }
  88.         if (!\is_array($id)) {
  89.             throw new \InvalidArgumentException(sprintf('$id must be array when "%s" key is set to true in the $context', IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER));
  90.         }
  91.         $identifiers = $id;
  93.         $fetchData = $context['fetch_data'] ?? true;
  94.         if (!$fetchData) {
  95.             return $manager->getReference($resourceClass, $identifiers);
  96.         }
  98.         $repository = $manager->getRepository($resourceClass);
  99.         if (!method_exists($repository, 'createQueryBuilder')) {
  100.             throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
  101.         }
  103.         $queryBuilder = $repository->createQueryBuilder('o');
  104.         $queryNameGenerator = new QueryNameGenerator();
  105.         $doctrineClassMetadata = $manager->getClassMetadata($resourceClass);
  107.         $this->addWhereForIdentifiers($identifiers, $queryBuilder, $doctrineClassMetadata, $queryNameGenerator);
  109.         foreach ($this->itemExtensions as $extension) {
  110.             if ($extension instanceof LegacyQueryItemExtensionInterface) {
  111.                 $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context);
  112.             }
  114.             if ($extension instanceof QueryItemExtensionInterface) {
  115.                 $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $context['operation'] ?? null, $context);
  116.             }
  118.             if ($extension instanceof LegacyQueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) { // @phpstan-ignore-line because of context
  119.                 return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context); // @phpstan-ignore-line because of context
  120.             }
  122.             if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $context['operation'] ?? null, $context)) {
  123.                 return $extension->getResult($queryBuilder, $resourceClass, $context['operation'] ?? null, $context);
  124.             }
  125.         }
  127.         return $queryBuilder->getQuery()->getOneOrNullResult();
  128.     }
  130.     /**
  131.      * Add WHERE conditions to the query for one or more identifiers (simple or composite).
  132.      */
  133.     private function addWhereForIdentifiers(array $identifiers, QueryBuilder $queryBuilder, ClassMetadata $classMetadata, $queryNameGenerator)
  134.     {
  135.         $alias = $queryBuilder->getRootAliases()[0];
  136.         foreach ($identifiers as $identifier => $value) {
  137.             $placeholder = $queryNameGenerator->generateParameterName($identifier);
  138.             $expression = $queryBuilder->expr()->eq(
  139.                 "{$alias}.{$identifier}",
  140.                 ':'.$placeholder
  141.             );
  143.             $queryBuilder->andWhere($expression);
  144.             $queryBuilder->setParameter($placeholder, $value, $classMetadata->getTypeOfField($identifier));
  145.         }
  146.     }
  147. }