RaListingRepository::createSearchQuery() - Code Metrics - Inspection of "Add actorId to ra-listing endpoint" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#267)

unknown

created 2019-02-14 14:41 UTC

RaListingRepository::createSearchQuery() C

↳ Parent: RaListingRepository

Complexity

Conditions	10
Paths	320

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	64
rs	5.0521
c	0
b	0
f	0
cc	10
nc	320
nop	1

How to fix Long Method Complexity

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddleware\ApiBundle\Identity\Repository;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Mapping;
use Surfnet\Stepup\Identity\Value\IdentityId;
use Surfnet\Stepup\Identity\Value\Institution;
use Surfnet\StepupMiddleware\ApiBundle\Authorization\Filter\InstitutionAuthorizationRepositoryFilter;
use Surfnet\StepupMiddleware\ApiBundle\Authorization\Value\InstitutionAuthorizationContextInterface;
use Surfnet\StepupMiddleware\ApiBundle\Exception\RuntimeException;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Entity\RaListing;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Query\RaListingQuery;

/**
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class RaListingRepository extends EntityRepository
{
    /**
     * @var InstitutionAuthorizationRepositoryFilter
     */
    private $authorizationRepositoryFilter;

    public function __construct(
        EntityManager $em,
        Mapping\ClassMetadata $class,
        InstitutionAuthorizationRepositoryFilter $authorizationRepositoryFilter
    ) {
        parent::__construct($em, $class);
        $this->authorizationRepositoryFilter = $authorizationRepositoryFilter;
    }

    /**
     * @param IdentityId $identityId The RA's identity id.
     * @return null|RaListing[]

     */
    public function findByIdentityId(IdentityId $identityId)
    {
        return parent::findBy(['identityId' => (string) $identityId]);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * @param IdentityId $identityId The RA's identity id.
     * @param Institution $raInstitution
     * @return null|RaListing

     */
    public function findByIdentityIdAndRaInstitution(IdentityId $identityId, Institution $raInstitution)
    {
        return parent::findOneBy([
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
            'identityId' => (string) $identityId,
            'raInstitution' => (string) $raInstitution,
        ]);
    }


    /**
     * @param IdentityId $identityId The RA's identity id.
     * @param Institution $raInstitution
     * @param InstitutionAuthorizationContextInterface $authorizationContext
     * @return null|RaListing
     */
    public function findByIdentityIdAndRaInstitutionWithContext(IdentityId $identityId, Institution $raInstitution, InstitutionAuthorizationContextInterface $authorizationContext)
    {
        $queryBuilder = $this->createQueryBuilder('r')
            ->where('r.identityId = :identityId')
            ->andWhere('r.raInstitution = :raInstitution')
            ->setParameter('identityId', $identityId)
            ->setParameter('raInstitution', (string)$raInstitution)
            ->orderBy('r.raInstitution');

        // Modify query to filter on authorization
        $this->authorizationRepositoryFilter->filter(
            $queryBuilder,
            $authorizationContext,
            'r.raInstitution',
            'iac'
        );

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

    /**
     * @param IdentityId $identityId The RA's identity id.
     * @param Institution $institution
     * @return RaListing[]
     */
    public function findByIdentityIdAndInstitution(IdentityId $identityId, Institution $institution)
    {
        return parent::findBy([
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
            'identityId' => (string) $identityId,
            'institution' => (string) $institution,
        ]);
    }

    public function save(RaListing $raListingEntry)
    {
        $this->getEntityManager()->persist($raListingEntry);
        $this->getEntityManager()->flush();
    }

    /**
     * @SuppressWarnings(PHPMD.CyclomaticComplexity) The amount of if statements do not necessarily make the method
     * @SuppressWarnings(PHPMD.NPathComplexity)      below complex or hard to maintain.
     *
     * @param RaListingQuery $query
     * @return \Doctrine\ORM\Query
     */
    public function createSearchQuery(RaListingQuery $query)
    {
        $queryBuilder = $this->createQueryBuilder('r');

        // Modify query to filter on authorization
        $this->authorizationRepositoryFilter->filter(
            $queryBuilder,
            $query->authorizationContext,
            'r.raInstitution',
            'iac'
        );

        if ($query->institution) {
            $queryBuilder
                ->andWhere('r.institution = :institution')
                ->setParameter('institution', $query->institution);
        }

        if ($query->identityId) {
            $queryBuilder
                ->andWhere('r.identityId = :identityId')
                ->setParameter('identityId', (string) $query->identityId);
        }

        if ($query->name) {
            $queryBuilder
                ->andWhere('r.commonName LIKE :name')
                ->setParameter('name', sprintf('%%%s%%', $query->name));
        }

        if ($query->email) {
            $queryBuilder
                ->andWhere('r.email LIKE :email')
                ->setParameter('email', sprintf('%%%s%%', $query->email));
        }

        if ($query->role) {
            $queryBuilder
                ->andWhere('r.role = :role')
                ->setParameter('role', (string) $query->role);
        }

        if ($query->raInstitution) {
            $queryBuilder
                ->andWhere('r.raInstitution = :raInstitution')
                ->setParameter('raInstitution', (string) $query->raInstitution);
        }

        if (!$query->orderBy) {
            return $queryBuilder->getQuery();
        }

        $orderDirection = $query->orderDirection === 'asc' ? 'ASC' : 'DESC';

        switch ($query->orderBy) {
            case 'commonName':
                $queryBuilder->orderBy('r.commonName', $orderDirection);
                break;
            default:
                throw new RuntimeException(sprintf('Unknown order by column "%s"', $query->orderBy));
        }

        return $queryBuilder->getQuery();
    }

    /**
     * @param Institution $raInstitution
     * @return ArrayCollection
     */
    public function listRasFor(Institution $raInstitution)
    {
        $listings = $this->createQueryBuilder('rl')
            ->where('rl.raInstitution = :institution')
            ->setParameter('institution', $raInstitution)
            ->getQuery()
            ->getResult();

        return new ArrayCollection($listings);
    }

    /**
     * @param IdentityId $identityId
     * @return void
     */
    public function removeByIdentityId(IdentityId $identityId)

    {
        $this->getEntityManager()->createQueryBuilder()
            ->delete($this->_entityName, 'ral')
            ->where('ral.identityId = :identityId')
            ->andWhere('ral.raInstitution = :institution')
            ->setParameter('identityId', $identityId->getIdentityId())
            ->getQuery()
            ->execute();
    }

    /**
     * @param IdentityId $identityId
     * @param Institution $raInstitution
     * @return void
     */
    public function removeByIdentityIdAndRaInstitution(IdentityId $identityId, Institution $raInstitution)
    {
        $this->getEntityManager()->createQueryBuilder()
            ->delete($this->_entityName, 'ral')
            ->where('ral.identityId = :identityId')
            ->andWhere('ral.raInstitution = :institution')
            ->setParameter('identityId', $identityId->getIdentityId())
            ->setParameter('institution', $raInstitution)
            ->getQuery()
            ->execute();
    }

    /**
     * @param IdentityId $identityId
     * @param Institution $institution
     * @return void
     */
    public function removeByIdentityIdAndInstitution(IdentityId $identityId, Institution $institution)
    {
        $this->getEntityManager()->createQueryBuilder()
            ->delete($this->_entityName, 'ral')
            ->where('ral.identityId = :identityId')
            ->andWhere('ral.institution = :institution')
            ->setParameter('identityId', $identityId->getIdentityId())
            ->setParameter('institution', $institution)
            ->getQuery()
            ->execute();
    }
}


1		<?php
2
3		/**
4		* Copyright 2014 SURFnet bv
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		namespace Surfnet\StepupMiddleware\ApiBundle\Identity\Repository;
20
21		use Doctrine\Common\Collections\ArrayCollection;
22		use Doctrine\ORM\EntityManager;
23		use Doctrine\ORM\EntityRepository;
24		use Doctrine\ORM\Mapping;
25		use Surfnet\Stepup\Identity\Value\IdentityId;
26		use Surfnet\Stepup\Identity\Value\Institution;
27		use Surfnet\StepupMiddleware\ApiBundle\Authorization\Filter\InstitutionAuthorizationRepositoryFilter;
28		use Surfnet\StepupMiddleware\ApiBundle\Authorization\Value\InstitutionAuthorizationContextInterface;
29		use Surfnet\StepupMiddleware\ApiBundle\Exception\RuntimeException;
30		use Surfnet\StepupMiddleware\ApiBundle\Identity\Entity\RaListing;
31		use Surfnet\StepupMiddleware\ApiBundle\Identity\Query\RaListingQuery;
32
33		/**
34		* @SuppressWarnings(PHPMD.TooManyPublicMethods)
35		*/
36		class RaListingRepository extends EntityRepository
37		{
38		/**
39		* @var InstitutionAuthorizationRepositoryFilter
40		*/
41		private $authorizationRepositoryFilter;
42
43		public function __construct(
44		EntityManager $em,
45		Mapping\ClassMetadata $class,
46		InstitutionAuthorizationRepositoryFilter $authorizationRepositoryFilter
47		) {
48		parent::__construct($em, $class);
49		$this->authorizationRepositoryFilter = $authorizationRepositoryFilter;
50		}
51
52		/**
53		* @param IdentityId $identityId The RA's identity id.
54		* @return null\|RaListing[]
		0 ignored issues – show Documentation introduced 2019-01-24 13:12 UTC by Report Bug Copy Issue Report Should the return type not be `array`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
55		*/
56		public function findByIdentityId(IdentityId $identityId)
57		{
58		return parent::findBy(['identityId' => (string) $identityId]);
		0 ignored issues – show Comprehensibility Bug introduced 2019-01-24 13:12 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`findBy()` instead of `findByIdentityId()`). Are you sure this is correct? If so, you might want to change this to `$this->findBy()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
59		}
60
61		/**
62		* @param IdentityId $identityId The RA's identity id.
63		* @param Institution $raInstitution
64		* @return null\|RaListing
		0 ignored issues – show Documentation introduced 2018-10-23 15:28 UTC by Report Bug Copy Issue Report Should the return type not be `object\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
65		*/
66		public function findByIdentityIdAndRaInstitution(IdentityId $identityId, Institution $raInstitution)
67		{
68		return parent::findOneBy([
		0 ignored issues – show Comprehensibility Bug introduced 2018-10-31 14:14 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`findOneBy()` instead of `findByIdentityIdAndRaInstitution()`). Are you sure this is correct? If so, you might want to change this to `$this->findOneBy()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
69		'identityId' => (string) $identityId,
70		'raInstitution' => (string) $raInstitution,
71		]);
72		}
73
74
75		/**
76		* @param IdentityId $identityId The RA's identity id.
77		* @param Institution $raInstitution
78		* @param InstitutionAuthorizationContextInterface $authorizationContext
79		* @return null\|RaListing
80		*/
81		public function findByIdentityIdAndRaInstitutionWithContext(IdentityId $identityId, Institution $raInstitution, InstitutionAuthorizationContextInterface $authorizationContext)
82		{
83		$queryBuilder = $this->createQueryBuilder('r')
84		->where('r.identityId = :identityId')
85		->andWhere('r.raInstitution = :raInstitution')
86		->setParameter('identityId', $identityId)
87		->setParameter('raInstitution', (string)$raInstitution)
88		->orderBy('r.raInstitution');
89
90		// Modify query to filter on authorization
91		$this->authorizationRepositoryFilter->filter(
92		$queryBuilder,
93		$authorizationContext,
94		'r.raInstitution',
95		'iac'
96		);
97
98		return $queryBuilder->getQuery()->getOneOrNullResult();
99		}
100
101		/**
102		* @param IdentityId $identityId The RA's identity id.
103		* @param Institution $institution
104		* @return RaListing[]
105		*/
106		public function findByIdentityIdAndInstitution(IdentityId $identityId, Institution $institution)
107		{
108		return parent::findBy([
		0 ignored issues – show Comprehensibility Bug introduced 2018-10-31 14:14 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`findBy()` instead of `findByIdentityIdAndInstitution()`). Are you sure this is correct? If so, you might want to change this to `$this->findBy()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
109		'identityId' => (string) $identityId,
110		'institution' => (string) $institution,
111		]);
112		}
113
114		public function save(RaListing $raListingEntry)
115		{
116		$this->getEntityManager()->persist($raListingEntry);
117		$this->getEntityManager()->flush();
118		}
119
120		/**
121		* @SuppressWarnings(PHPMD.CyclomaticComplexity) The amount of if statements do not necessarily make the method
122		* @SuppressWarnings(PHPMD.NPathComplexity) below complex or hard to maintain.
123		*
124		* @param RaListingQuery $query
125		* @return \Doctrine\ORM\Query
126		*/
127		public function createSearchQuery(RaListingQuery $query)
128		{
129		$queryBuilder = $this->createQueryBuilder('r');
130
131		// Modify query to filter on authorization
132		$this->authorizationRepositoryFilter->filter(
133		$queryBuilder,
134		$query->authorizationContext,
135		'r.raInstitution',
136		'iac'
137		);
138
139		if ($query->institution) {
140		$queryBuilder
141		->andWhere('r.institution = :institution')
142		->setParameter('institution', $query->institution);
143		}
144
145		if ($query->identityId) {
146		$queryBuilder
147		->andWhere('r.identityId = :identityId')
148		->setParameter('identityId', (string) $query->identityId);
149		}
150
151		if ($query->name) {
152		$queryBuilder
153		->andWhere('r.commonName LIKE :name')
154		->setParameter('name', sprintf('%%%s%%', $query->name));
155		}
156
157		if ($query->email) {
158		$queryBuilder
159		->andWhere('r.email LIKE :email')
160		->setParameter('email', sprintf('%%%s%%', $query->email));
161		}
162
163		if ($query->role) {
164		$queryBuilder
165		->andWhere('r.role = :role')
166		->setParameter('role', (string) $query->role);
167		}
168
169		if ($query->raInstitution) {
170		$queryBuilder
171		->andWhere('r.raInstitution = :raInstitution')
172		->setParameter('raInstitution', (string) $query->raInstitution);
173		}
174
175		if (!$query->orderBy) {
176		return $queryBuilder->getQuery();
177		}
178
179		$orderDirection = $query->orderDirection === 'asc' ? 'ASC' : 'DESC';
180
181		switch ($query->orderBy) {
182		case 'commonName':
183		$queryBuilder->orderBy('r.commonName', $orderDirection);
184		break;
185		default:
186		throw new RuntimeException(sprintf('Unknown order by column "%s"', $query->orderBy));
187		}
188
189		return $queryBuilder->getQuery();
190		}
191
192		/**
193		* @param Institution $raInstitution
194		* @return ArrayCollection
195		*/
196		public function listRasFor(Institution $raInstitution)
197		{
198		$listings = $this->createQueryBuilder('rl')
199		->where('rl.raInstitution = :institution')
200		->setParameter('institution', $raInstitution)
201		->getQuery()
202		->getResult();
203
204		return new ArrayCollection($listings);
205		}
206
207		/**
208		* @param IdentityId $identityId
209		* @return void
210		*/
211	View Code Duplication	public function removeByIdentityId(IdentityId $identityId)
		0 ignored issues – show Duplication introduced 2017-08-01 07:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
212		{
213		$this->getEntityManager()->createQueryBuilder()
214		->delete($this->_entityName, 'ral')
215		->where('ral.identityId = :identityId')
216		->andWhere('ral.raInstitution = :institution')
217		->setParameter('identityId', $identityId->getIdentityId())
218		->getQuery()
219		->execute();
220		}
221
222		/**
223		* @param IdentityId $identityId
224		* @param Institution $raInstitution
225		* @return void
226		*/
227		public function removeByIdentityIdAndRaInstitution(IdentityId $identityId, Institution $raInstitution)
228		{
229		$this->getEntityManager()->createQueryBuilder()
230		->delete($this->_entityName, 'ral')
231		->where('ral.identityId = :identityId')
232		->andWhere('ral.raInstitution = :institution')
233		->setParameter('identityId', $identityId->getIdentityId())
234		->setParameter('institution', $raInstitution)
235		->getQuery()
236		->execute();
237		}
238
239		/**
240		* @param IdentityId $identityId
241		* @param Institution $institution
242		* @return void
243		*/
244		public function removeByIdentityIdAndInstitution(IdentityId $identityId, Institution $institution)
245		{
246		$this->getEntityManager()->createQueryBuilder()
247		->delete($this->_entityName, 'ral')
248		->where('ral.identityId = :identityId')
249		->andWhere('ral.institution = :institution')
250		->setParameter('identityId', $identityId->getIdentityId())
251		->setParameter('institution', $institution)
252		->getQuery()
253		->execute();
254		}
255		}
256

OpenConext / Stepup-Middleware

Pull Request — develop (#267)

RaListingRepository::createSearchQuery() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like