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-02-03 17:24 UTC

SubcollectionDataProvider::getSubcollection() A

↳ Parent: SubcollectionDataProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	52
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	52
rs	9.4929
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	3

How to fix Long Method

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\Util\QueryNameGenerator;
15			use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\IdentifierManagerTrait;
16			use ApiPlatform\Core\DataProvider\SubcollectionDataProviderInterface;
17			use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
18			use ApiPlatform\Core\Exception\RuntimeException;
19			use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
20			use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
21			use Doctrine\Common\Persistence\ManagerRegistry;
22			use Doctrine\ORM\EntityManagerInterface;
23
24			/**
25			* Subcollection data provider for the Doctrine ORM.
26			*
27			* @author Antoine Bluchet <[email protected]>
28			*/
29			class SubcollectionDataProvider implements SubcollectionDataProviderInterface
30			{
31			use IdentifierManagerTrait;
32
33			private $managerRegistry;
34			private $collectionExtensions;
35
36			/**
37			* @param ManagerRegistry $managerRegistry
38			* @param PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory
39			* @param PropertyMetadataFactoryInterface $propertyMetadataFactory
40			* @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...
41			*/
42			public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, array $collectionExtensions = [])
43			{
44			$this->managerRegistry = $managerRegistry;
45			$this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
46			$this->propertyMetadataFactory = $propertyMetadataFactory;
47			$this->collectionExtensions = $collectionExtensions;
48			}
49
50			/**
51			* {@inheritdoc}
52			*
53			* @throws RuntimeException
54			*/
55			public function getSubcollection(string $resourceClass, array $identifiers, array $context = [])
56			{
57			// $manager = $this->managerRegistry->getManagerForClass($resourceClass);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
58			// if (null === $manager) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
59			// throw new ResourceClassNotSupportedException();
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
60			// }
61			//
62			// $identifiers = $this->normalizeIdentifiers($id, $manager, $resourceClass);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
63			//
64			// $fetchData = $context['fetch_data'] ?? true;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
65			// if (!$fetchData && $manager instanceof EntityManagerInterface) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `53%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
66			// return $manager->getReference($resourceClass, $identifiers);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
67			// }
68			//
69			// $classMetadata = $manager->getClassMetadata($resourceClass);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
70			// $subResourceClass = $classMetadata->getAssociationTargetClass($subcollectionProperty);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
71			// $subResourceClassMetadata = $manager->getClassMetadata($subResourceClass);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
72			//
73			// $repository = $manager->getRepository($subResourceClass);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
74			// if (!method_exists($repository, 'createQueryBuilder')) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
75			// throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
76			// }
77			//
78			// $queryBuilder = $repository->createQueryBuilder('o');
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
79			//
80			// $where = null;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
81			// foreach ($identifiers as $identifier => $value) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `57%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
82			// $placeholder = ':id_'.$identifier;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
83			// $expression = "parentResourceClass.$identifier = $placeholder";
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
84			//
85			// $where = $where ? "$where AND $expression" : $expression;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `47%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
86			// $queryBuilder->setParameter($placeholder, $value);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `73%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
87			// }
88			//
89			// //@TODO support composite identifiers relation
90			// $queryBuilder->andWhere(sprintf(
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
91			// 'o.%s IN (SELECT child.%1$s FROM %s parentResourceClass JOIN parentResourceClass.%s child WHERE %s)',
92			// $subResourceClassMetadata->getSingleIdentifierFieldName(), $resourceClass, $subcollectionProperty, $where
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
93			// ));
94			//
95			// $queryNameGenerator = new QueryNameGenerator();
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `46%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
96			//
97			// foreach ($this->collectionExtensions as $extension) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
98			// $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `71%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
99			//
100			// if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName)) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
101			// return $extension->getResult($queryBuilder);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
102			// }
103			// }
104			//
105			// return $queryBuilder->getQuery()->getResult();
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-02-03 17:27 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
106			}
107			}
108

api-platform / core

Pull Request — master (#904)

SubcollectionDataProvider::getSubcollection() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like