vendor/api-platform/core/src/Doctrine/Orm/State/CollectionProvider.php line 40

  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\Doctrine\Orm\State;
  16. use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
  17. use ApiPlatform\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
  18. use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
  19. use ApiPlatform\Exception\RuntimeException;
  20. use ApiPlatform\Metadata\Operation;
  21. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  22. use ApiPlatform\State\ProviderInterface;
  23. use Doctrine\ORM\EntityManagerInterface;
  24. use Doctrine\Persistence\ManagerRegistry;
  25. use Psr\Container\ContainerInterface;
  27. /**
  28.  * Collection state provider using the Doctrine ORM.
  29.  *
  30.  * @author Kévin Dunglas <kevin@dunglas.fr>
  31.  * @author Samuel ROZE <samuel.roze@gmail.com>
  32.  */
  33. final class CollectionProvider implements ProviderInterface
  34. {
  35.     use LinksHandlerTrait;
  37.     /**
  38.      * @param QueryCollectionExtensionInterface[] $collectionExtensions
  39.      */
  40.     public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, private readonly ManagerRegistry $managerRegistry, private readonly iterable $collectionExtensions = [], ContainerInterface $handleLinksLocator = null)
  41.     {
  42.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  43.         $this->handleLinksLocator = $handleLinksLocator;
  44.     }
  46.     public function provide(Operation $operation, array $uriVariables = [], array $context = []): iterable
  47.     {
  48.         $entityClass = $operation->getClass();
  49.         if (($options = $operation->getStateOptions()) && $options instanceof Options && $options->getEntityClass()) {
  50.             $entityClass = $options->getEntityClass();
  51.         }
  53.         /** @var EntityManagerInterface $manager */
  54.         $manager = $this->managerRegistry->getManagerForClass($entityClass);
  56.         $repository = $manager->getRepository($entityClass);
  57.         if (!method_exists($repository, 'createQueryBuilder')) {
  58.             throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
  59.         }
  61.         $queryBuilder = $repository->createQueryBuilder('o');
  62.         $queryNameGenerator = new QueryNameGenerator();
  64.         if ($handleLinks = $this->getLinksHandler($operation)) {
  65.             $handleLinks($queryBuilder, $uriVariables, $queryNameGenerator, ['entityClass' => $entityClass, 'operation' => $operation] + $context);
  66.         } else {
  67.             $this->handleLinks($queryBuilder, $uriVariables, $queryNameGenerator, $context, $entityClass, $operation);
  68.         }
  70.         foreach ($this->collectionExtensions as $extension) {
  71.             $extension->applyToCollection($queryBuilder, $queryNameGenerator, $entityClass, $operation, $context);
  73.             if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($entityClass, $operation, $context)) {
  74.                 return $extension->getResult($queryBuilder, $entityClass, $operation, $context);
  75.             }
  76.         }
  78.         return $queryBuilder->getQuery()->getResult();
  79.     }
  80. }