SubcollectionDataProvider::getSubcollection() - Code Metrics - Inspection of "[WIP] wip nested data implementation" - api-platform/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#904)

by Antoine

created 2017-01-11 15:48 UTC

SubcollectionDataProvider::getSubcollection() C

↳ Parent: SubcollectionDataProvider

Complexity

Conditions	10
Paths	12

Size

Total Lines	52
Code Lines	30

Duplication

Lines	7
Ratio	13.46 %

Importance

Changes

Metric	Value
dl	7
loc	52
rs	6.2553
c	0
b	0
f	0
cc	10
eloc	30
nc	12
nop	5

How to fix Long Method Complexity

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <[email protected]>
 *
 * 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\QueryItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\IdentifiersHelper;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
use ApiPlatform\Core\DataProvider\SubcollectionDataProviderInterface;
use ApiPlatform\Core\Exception\PropertyNotFoundException;
use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
use ApiPlatform\Core\Exception\RuntimeException;
use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\QueryBuilder;

/**
 * Subcollection data provider for the Doctrine ORM.
 *
 * @author Antoine Bluchet <[email protected]>
 */
class SubcollectionDataProvider implements SubcollectionDataProviderInterface
{
    private $managerRegistry;
    private $identifiersHelper;
    private $collectionExtensions;

    /**
     * @param ManagerRegistry                        $managerRegistry
     * @param PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param PropertyMetadataFactoryInterface       $propertyMetadataFactory
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param QueryItemExtensionInterface[]          $itemExtensions
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct(ManagerRegistry $managerRegistry, IdentifiersHelper $identifiersHelper, array $collectionExtensions = [])
    {
        $this->managerRegistry = $managerRegistry;
        $this->identifiersHelper = $identifiersHelper;
        $this->collectionExtensions = $collectionExtensions;
    }

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

        $identifiers = $this->identifiersHelper->normalizeIdentifiers($id, $manager, $resourceClass);

        $fetchData = $context['fetch_data'] ?? true;
        if (!$fetchData && $manager instanceof EntityManagerInterface) {
            return $manager->getReference($resourceClass, $identifiers);
        }

        $classMetadata = $manager->getClassMetadata($resourceClass);
        $subResourceClass = $classMetadata->getAssociationTargetClass($subcollectionProperty);
        $subResourceClassMetadata = $manager->getClassMetadata($subResourceClass);

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

        $queryBuilder = $repository->createQueryBuilder('o');

        $where = null;
        foreach ($identifiers as $identifier => $value) {
            $placeholder = ':id_'.$identifier;
            $expression = sprintf('parentResourceClass.%s = %s', $identifier, $placeholder);

            $where = !$where ? $expression : $with.' AND '.$expression;

            $queryBuilder->setParameter($placeholder, $value);
        }

        //@TODO support composite identifiers relation
        $queryBuilder->andWhere(sprintf(
            'o.%s IN (SELECT child.%1$s FROM %s parentResourceClass JOIN parentResourceClass.%s child WHERE %s)', 
            $subResourceClassMetadata->getSingleIdentifierFieldName(), $resourceClass, $subcollectionProperty, $where
        ));

        $queryNameGenerator = new QueryNameGenerator();

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

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

            if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return $extension->getResult($queryBuilder);
            }
        }

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


1		<?php
2
3		/*
4		* This file is part of the API Platform project.
5		*
6		* (c) Kévin Dunglas <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ApiPlatform\Core\Bridge\Doctrine\Orm;
13
14		use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
15		use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
16		use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\IdentifiersHelper;
17		use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
18		use ApiPlatform\Core\DataProvider\SubcollectionDataProviderInterface;
19		use ApiPlatform\Core\Exception\PropertyNotFoundException;
20		use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
21		use ApiPlatform\Core\Exception\RuntimeException;
22		use Doctrine\Common\Persistence\ManagerRegistry;
23		use Doctrine\Common\Persistence\ObjectManager;
24		use Doctrine\ORM\EntityManagerInterface;
25		use Doctrine\ORM\QueryBuilder;
26
27		/**
28		* Subcollection data provider for the Doctrine ORM.
29		*
30		* @author Antoine Bluchet <[email protected]>
31		*/
32		class SubcollectionDataProvider implements SubcollectionDataProviderInterface
33		{
34		private $managerRegistry;
35		private $identifiersHelper;
36		private $collectionExtensions;
37
38		/**
39		* @param ManagerRegistry $managerRegistry
40		* @param PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory
		0 ignored issues – show Bug introduced 2017-01-11 16:09 UTC by Report Bug Copy Issue Report There is no parameter named `$propertyNameCollectionFactory`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
41		* @param PropertyMetadataFactoryInterface $propertyMetadataFactory
		0 ignored issues – show Bug introduced 2017-01-11 16:09 UTC by Report Bug Copy Issue Report There is no parameter named `$propertyMetadataFactory`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
42		* @param QueryItemExtensionInterface[] $itemExtensions
		0 ignored issues – show Bug introduced 2017-01-11 16:09 UTC by Report Bug Copy Issue Report There is no parameter named `$itemExtensions`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
43		*/
44		public function __construct(ManagerRegistry $managerRegistry, IdentifiersHelper $identifiersHelper, array $collectionExtensions = [])
45		{
46		$this->managerRegistry = $managerRegistry;
47		$this->identifiersHelper = $identifiersHelper;
48		$this->collectionExtensions = $collectionExtensions;
49		}
50
51		/**
52		* {@inheritdoc}
53		*
54		* @throws RuntimeException
55		*/
56		public function getSubcollection(string $resourceClass, $id, string $subcollectionProperty, string $operationName = null, array $context = [])
57		{
58		$manager = $this->managerRegistry->getManagerForClass($resourceClass);
59		if (null === $manager) {
60		throw new ResourceClassNotSupportedException();
61		}
62
63		$identifiers = $this->identifiersHelper->normalizeIdentifiers($id, $manager, $resourceClass);
64
65		$fetchData = $context['fetch_data'] ?? true;
66		if (!$fetchData && $manager instanceof EntityManagerInterface) {
67		return $manager->getReference($resourceClass, $identifiers);
68		}
69
70		$classMetadata = $manager->getClassMetadata($resourceClass);
71		$subResourceClass = $classMetadata->getAssociationTargetClass($subcollectionProperty);
72		$subResourceClassMetadata = $manager->getClassMetadata($subResourceClass);
73
74		$repository = $manager->getRepository($subResourceClass);
75		if (!method_exists($repository, 'createQueryBuilder')) {
76		throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
77		}
78
79		$queryBuilder = $repository->createQueryBuilder('o');
80
81		$where = null;
82		foreach ($identifiers as $identifier => $value) {
83		$placeholder = ':id_'.$identifier;
84		$expression = sprintf('parentResourceClass.%s = %s', $identifier, $placeholder);
85
86		$where = !$where ? $expression : $with.' AND '.$expression;
		0 ignored issues – show Bug introduced 2017-01-11 16:09 UTC by Report Bug Copy Issue Report The variable `$with` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
87		$queryBuilder->setParameter($placeholder, $value);
88		}
89
90		//@TODO support composite identifiers relation
91		$queryBuilder->andWhere(sprintf(
92		'o.%s IN (SELECT child.%1$s FROM %s parentResourceClass JOIN parentResourceClass.%s child WHERE %s)',
93		$subResourceClassMetadata->getSingleIdentifierFieldName(), $resourceClass, $subcollectionProperty, $where
94		));
95
96		$queryNameGenerator = new QueryNameGenerator();
97
98	View Code Duplication	foreach ($this->collectionExtensions as $extension) {
		0 ignored issues – show Duplication introduced 2017-01-11 16:09 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
99		$extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName);
100
101		if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName)) {
		0 ignored issues – show Bug introduced 2017-01-11 16:09 UTC by Report Bug Copy Issue Report The class `ApiPlatform\Core\Bridge\...ctionExtensionInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
102		return $extension->getResult($queryBuilder);
103		}
104		}
105
106		return $queryBuilder->getQuery()->getResult();
107		}
108		}
109

api-platform / core

Pull Request — master (#904)

SubcollectionDataProvider::getSubcollection() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like