ApiPlatform\Core\Bridge\Doctrine\Orm\SubcollectionDataProvider

Complexity

Total Complexity

14

Size/Duplication

Total Lines	119
Duplicated Lines	5.88 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
D	getSubcollection()	7	92	13

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ApiPlatform\Core\Bridge\Doctrine\Orm;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\IdentifierManagerTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
use ApiPlatform\Core\DataProvider\SubcollectionDataProviderInterface;
use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping\ClassMetadataInfo;

/**
 * Subcollection data provider for the Doctrine ORM.
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 */
class SubcollectionDataProvider implements SubcollectionDataProviderInterface
{
    use IdentifierManagerTrait;

    private $managerRegistry;
    private $collectionExtensions;

    /**
     * @param ManagerRegistry                        $managerRegistry
     * @param PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory
     * @param PropertyMetadataFactoryInterface       $propertyMetadataFactory
     * @param QueryItemExtensionInterface[]          $itemExtensions

There is no parameter named $itemExtensions. Was it maybe removed?

     */
    public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, array $collectionExtensions = [])
    {
        $this->managerRegistry = $managerRegistry;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->collectionExtensions = $collectionExtensions;
    }

    /**
     * {@inheritdoc}
     *
     * @throws RuntimeException
     */
    public function getSubcollection(string $resourceClass, array $identifiers, array $context, string $operationName = null)
    {
        $manager = $this->managerRegistry->getManagerForClass($resourceClass);
        if (null === $manager) {
            throw new ResourceClassNotSupportedException();
        }

        $repository = $manager->getRepository($resourceClass);
        if (!method_exists($repository, 'createQueryBuilder')) {
            throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
        }

        if (!isset($context['identifiers']) || !isset($context['property'])) {
            throw new ResourceClassNotSupportedException('The given resource class is not a subcollection.');
        }

        $queryBuilder = $repository->createQueryBuilder('o');
        $queryNameGenerator = new QueryNameGenerator();
        $previousQueryBuilder = null;
        $previousAlias = null;

        $num = count($context['identifiers']);

        while ($num--) {
            list($identifier, $identifierResourceClass) = $context['identifiers'][$num];
            $previousIdentifier = $context['identifiers'][$num + 1][0] ?? $context['property'];

            $manager = $this->managerRegistry->getManagerForClass($identifierResourceClass);

            if (!$manager instanceof EntityManagerInterface) {
                throw new RuntimeException("The manager for $identifierResourceClass must be an EntityManager.");
            }

            $classMetadata = $manager->getClassMetadata($identifierResourceClass);

            $qb = $manager->createQueryBuilder();
            $alias = $queryNameGenerator->generateJoinAlias($identifier);

            //MANY_TO_MANY relations needs an explicit join so that the identifier part can be retrieved
            if ($classMetadata->getAssociationMapping($previousIdentifier)['type'] === ClassMetadataInfo::MANY_TO_MANY) {
                $joinAlias = $queryNameGenerator->generateJoinAlias($previousIdentifier);

                $qb->select($joinAlias)
                    ->from($identifierResourceClass, $alias)
                    ->innerJoin("$alias.$previousIdentifier", $joinAlias);
            } else {
                $qb->select("IDENTITY($alias.$previousIdentifier)")
                    ->from($identifierResourceClass, $alias);
            }

            $normalizedIdentifiers = $this->normalizeIdentifiers($identifiers[$identifier], $manager, $identifierResourceClass);

            foreach ($normalizedIdentifiers as $key => $value) {
                $placeholder = $queryNameGenerator->generateParameterName($key);
                $qb->andWhere("$alias.$key = :$placeholder");
                $queryBuilder->setParameter($placeholder, $value);
            }

            if (null === $previousQueryBuilder) {
                $previousQueryBuilder = $qb;
            } else {
                $previousQueryBuilder->andWhere($qb->expr()->in($previousAlias, $qb->getDQL()));
            }

            $previousAlias = $alias;
        }

        /*
         * The following translate to this pseudo-dql:
         *
         * SELECT thirdLevel WHERE thirdLevel IN (
         *   SELECT thirdLevel FROM relatedDummies WHERE relatedDummies = ? AND relatedDummies IN (
         *     SELECT relatedDummies FROM Dummy WHERE Dummy = ?
         *   )
         * )
         *
         * By using subqueries, we're forcing the SQL execution plan to go through indexes on doctrine identifiers.
         */
        $queryBuilder->where(
            $queryBuilder->expr()->in('o', $previousQueryBuilder->getDQL())
        );

        foreach ($this->collectionExtensions as $extension) {

This code seems to be duplicated across your project.

            $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName);

            if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName)) {
                return $extension->getResult($queryBuilder);
            }
        }

        return $queryBuilder->getQuery()->getResult();
    }
}