ApiPlatform\Core\Bridge\Doctrine\Orm\SubresourceDataProvider

Complexity

Total Complexity

22

Size/Duplication

Total Lines	157
Duplicated Lines	9.55 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	8	8	1
D	getSubresource()	7	127	21

<?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.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Doctrine\Orm;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\FilterEagerLoadingExtension;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\IdentifierManagerTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
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;
use Doctrine\ORM\QueryBuilder;

/**
 * Subresource data provider for the Doctrine ORM.
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 */
final class SubresourceDataProvider implements SubresourceDataProviderInterface
{
    use IdentifierManagerTrait;

    private $managerRegistry;
    private $collectionExtensions;
    private $itemExtensions;

    /**
     * @param ManagerRegistry                        $managerRegistry
     * @param PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory
     * @param PropertyMetadataFactoryInterface       $propertyMetadataFactory
     * @param QueryCollectionExtensionInterface[]    $collectionExtensions
     * @param QueryItemExtensionInterface[]          $itemExtensions
     */
    public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, array $collectionExtensions = [], array $itemExtensions = [])

This method seems to be duplicated in your project.

    {
        $this->managerRegistry = $managerRegistry;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->collectionExtensions = $collectionExtensions;
        $this->itemExtensions = $itemExtensions;
    }

    /**
     * {@inheritdoc}
     *
     * @throws RuntimeException
     */
    public function getSubresource(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 subresource.');
        }

        $queryNameGenerator = new QueryNameGenerator();

        $buildQuery = function (int $remainingIdentifiers, QueryBuilder $previousQueryBuilder, string $previousAlias, QueryBuilder $topQueryBuilder = null) use (&$buildQuery, $queryNameGenerator, $context, $identifiers): QueryBuilder {
            if (!$remainingIdentifiers) {
                return $previousQueryBuilder;
            }

            $topQueryBuilder = $topQueryBuilder ?? $previousQueryBuilder;

            list($identifier, $identifierResourceClass) = $context['identifiers'][$remainingIdentifiers - 1];
            $previousAssociationProperty = $context['identifiers'][$remainingIdentifiers][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);

            if (!$classMetadata instanceof ClassMetadataInfo) {
                throw new RuntimeException(
                    "The class metadata for $identifierResourceClass must be an instance of ClassMetadataInfo."
                );
            }

            $qb = $manager->createQueryBuilder();
            $alias = $queryNameGenerator->generateJoinAlias($identifier);
            $relationType = $classMetadata->getAssociationMapping($previousAssociationProperty)['type'];
            $normalizedIdentifiers = isset($identifiers[$identifier]) ? $this->normalizeIdentifiers(
                $identifiers[$identifier],
                $manager,
                $identifierResourceClass
            ) : [];

            switch ($relationType) {
                // MANY_TO_MANY relations need an explicit join so that the identifier part can be retrieved
                case ClassMetadataInfo::MANY_TO_MANY:

case statements should be defined using a colon.

                    $joinAlias = $queryNameGenerator->generateJoinAlias($previousAssociationProperty);

                    $qb->select($joinAlias)
                        ->from($identifierResourceClass, $alias)
                        ->innerJoin("$alias.$previousAssociationProperty", $joinAlias);

                    break;
                case ClassMetadataInfo::ONE_TO_MANY:

case statements should be defined using a colon.

                    $mappedBy = $classMetadata->getAssociationMapping($previousAssociationProperty)['mappedBy'];

                    $previousAlias = "$previousAlias.$mappedBy";

                    $qb->select($alias)
                        ->from($identifierResourceClass, $alias);
                    break;
                default:

DEFAULT statements must be defined using a colon

                    $qb->select("IDENTITY($alias.$previousAssociationProperty)")
                        ->from($identifierResourceClass, $alias);
            }

            // Add where clause for identifiers
            foreach ($normalizedIdentifiers as $key => $value) {
                $placeholder = $queryNameGenerator->generateParameterName($key);
                $qb->andWhere("$alias.$key = :$placeholder");
                $topQueryBuilder->setParameter($placeholder, $value);
            }

            // Recurse queries
            $qb = $buildQuery(--$remainingIdentifiers, $qb, $alias, $topQueryBuilder);

            return $previousQueryBuilder->andWhere($qb->expr()->in($previousAlias, $qb->getDQL()));
        };

        /*
         * The following recursively translates 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 = $buildQuery(\count($context['identifiers']), $repository->createQueryBuilder($alias = 'o'), $alias);

        if (true === $context['collection']) {
            foreach ($this->collectionExtensions as $extension) {
                // We don't need this anymore because we already made sub queries to ensure correct results
                if ($extension instanceof FilterEagerLoadingExtension) {
                    continue;
                }

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

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

The call to QueryResultCollectionExtensionInterface::getResult() has too many arguments starting with $resourceClass.

                }
            }
        } else {
            foreach ($this->itemExtensions as $extension) {

This code seems to be duplicated across your project.

                $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context);

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

The call to QueryResultItemExtensionInterface::getResult() has too many arguments starting with $resourceClass.

                }
            }
        }

        $query = $queryBuilder->getQuery();

        return $context['collection'] ? $query->getResult() : $query->getOneOrNullResult();
    }
}