RaSecondFactorRepository::createSearchQuery() - Code Metrics - Inspection of "Fix authorization filter" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#261)

by Michiel

created 2019-02-04 08:16 UTC

RaSecondFactorRepository::createSearchQuery() F

↳ Parent: RaSecondFactorRepository

Complexity

Conditions	16
Paths	480

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	69
rs	2.1222
c	0
b	0
f	0
cc	16
nc	480
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\DBAL\Types\Type;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Mapping;
use Doctrine\ORM\Query;
use Surfnet\Stepup\Exception\RuntimeException;
use Surfnet\Stepup\Identity\Value\IdentityId;
use Surfnet\StepupMiddleware\ApiBundle\Authorization\Filter\InstitutionAuthorizationRepositoryFilter;
use Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type\SecondFactorStatusType;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Entity\RaSecondFactor;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Query\RaSecondFactorQuery;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Value\SecondFactorStatus;

class RaSecondFactorRepository extends EntityRepository
{
    /**
     * @var InstitutionAuthorizationRepositoryFilter
     */
    private $authorizationRepositoryFilter;

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


    /**
     * @param string $id
     * @return RaSecondFactor|null
     */
    public function find($id)
    {
        /** @var RaSecondFactor|null $secondFactor */
        $secondFactor = parent::find($id);

        return $secondFactor;
    }

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

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

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


    /**
     * @param string $institution
     * @return RaSecondFactor[]
     */
    public function findByInstitution($institution)
    {
        return parent::findBy(['institution' => $institution]);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

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

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

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

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

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

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

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

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

        if ($query->status) {
            $stringStatus = $query->status;
            if (!SecondFactorStatus::isValidStatus($stringStatus)) {
                throw new RuntimeException(sprintf(
                    'Received invalid status "%s" in RaSecondFactorRepository::createSearchQuery',
                    is_object($stringStatus) ? get_class($stringStatus) : (string) $stringStatus
                ));
            }

            // we need to resolve the string value to database value using the correct doctrine type. Normally this is
            // done by doctrine itself, however the queries PagerFanta creates somehow manages to mangle this...
            // so we do it by hand
            $doctrineType = Type::getType(SecondFactorStatusType::NAME);
            $secondFactorStatus = SecondFactorStatus::$stringStatus();

            $databaseValue = $doctrineType->convertToDatabaseValue(
                $secondFactorStatus,
                $this->getEntityManager()->getConnection()->getDatabasePlatform()
            );

            $queryBuilder->andWhere('sf.status = :status')->setParameter('status', $databaseValue);
        }

        switch ($query->orderBy) {
            case 'name':
            case 'type':
            case 'secondFactorId':
            case 'email':
            case 'institution':
            case 'status':
                $queryBuilder->orderBy(
                    sprintf('sf.%s', $query->orderBy),
                    $query->orderDirection === 'desc' ? 'DESC' : 'ASC'
                );
                break;
        }

        return $queryBuilder->getQuery();
    }

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

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

    public function save(RaSecondFactor $secondFactor)
    {
        $this->getEntityManager()->persist($secondFactor);
        $this->getEntityManager()->flush();
    }

    /**
     * @param RaSecondFactor[] $secondFactors
     */
    public function saveAll(array $secondFactors)
    {
        $entityManager = $this->getEntityManager();

        foreach ($secondFactors as $secondFactor) {
            $entityManager->persist($secondFactor);
        }

        $entityManager->flush();
    }
}


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\DBAL\Types\Type;
22		use Doctrine\ORM\EntityManager;
23		use Doctrine\ORM\EntityRepository;
24		use Doctrine\ORM\Mapping;
25		use Doctrine\ORM\Query;
26		use Surfnet\Stepup\Exception\RuntimeException;
27		use Surfnet\Stepup\Identity\Value\IdentityId;
28		use Surfnet\StepupMiddleware\ApiBundle\Authorization\Filter\InstitutionAuthorizationRepositoryFilter;
29		use Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type\SecondFactorStatusType;
30		use Surfnet\StepupMiddleware\ApiBundle\Identity\Entity\RaSecondFactor;
31		use Surfnet\StepupMiddleware\ApiBundle\Identity\Query\RaSecondFactorQuery;
32		use Surfnet\StepupMiddleware\ApiBundle\Identity\Value\SecondFactorStatus;
33
34		class RaSecondFactorRepository extends EntityRepository
35		{
36		/**
37		* @var InstitutionAuthorizationRepositoryFilter
38		*/
39		private $authorizationRepositoryFilter;
40
41		public function __construct(
42		EntityManager $em,
43		Mapping\ClassMetadata $class,
44		InstitutionAuthorizationRepositoryFilter $authorizationRepositoryFilter
45		) {
46		parent::__construct($em, $class);
47		$this->authorizationRepositoryFilter = $authorizationRepositoryFilter;
48		}
49
50
51		/**
52		* @param string $id
53		* @return RaSecondFactor\|null
54		*/
55		public function find($id)
56		{
57		/** @var RaSecondFactor\|null $secondFactor */
58		$secondFactor = parent::find($id);
59
60		return $secondFactor;
61		}
62
63		/**
64		* @param string $identityId
65		* @return RaSecondFactor[]
66		*/
67		public function findByIdentityId($identityId)
68		{
69		return parent::findBy(['identityId' => $identityId]);
		0 ignored issues – show Comprehensibility Bug introduced 2015-12-15 13:40 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...
70		}
71
72
73		/**
74		* @param string $institution
75		* @return RaSecondFactor[]
76		*/
77		public function findByInstitution($institution)
78		{
79		return parent::findBy(['institution' => $institution]);
		0 ignored issues – show Comprehensibility Bug introduced 2019-01-31 16:20 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`findBy()` instead of `findByInstitution()`). 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...
80		}
81
82		/**
83		* @SuppressWarnings(PHPMD.CyclomaticComplexity) The amount of if statements do not necessarily make the method
84		* below complex or hard to maintain.
85		* @SuppressWarnings(PHPMD.NPathComplexity)
86		*
87		* @param RaSecondFactorQuery $query
88		* @return Query
89		* @throws \Doctrine\DBAL\DBALException
90		*/
91		public function createSearchQuery(RaSecondFactorQuery $query)
92		{
93		$queryBuilder = $this
94		->createQueryBuilder('sf');
95
96		// Modify query to filter on authorization
97		$this->authorizationRepositoryFilter->filter($queryBuilder, $query->authorizationContext, 'sf.id', 'sf.institution', 'iac');
98
99		if ($query->name) {
100		$queryBuilder->andWhere('sf.name LIKE :name')->setParameter('name', sprintf('%%%s%%', $query->name));
101		}
102
103		if ($query->type) {
104		$queryBuilder->andWhere('sf.type = :type')->setParameter('type', $query->type);
105		}
106
107		if ($query->secondFactorId) {
108		$queryBuilder
109		->andWhere('sf.secondFactorId = :secondFactorId')
110		->setParameter('secondFactorId', $query->secondFactorId);
111		}
112
113		if ($query->email) {
114		$queryBuilder->andWhere('sf.email LIKE :email')->setParameter('email', sprintf('%%%s%%', $query->email));
115		}
116
117		if ($query->institution) {
118		$queryBuilder->andWhere('sf.institution = :institution')->setParameter('institution', $query->institution);
119		}
120
121		if ($query->status) {
122		$stringStatus = $query->status;
123		if (!SecondFactorStatus::isValidStatus($stringStatus)) {
124		throw new RuntimeException(sprintf(
125		'Received invalid status "%s" in RaSecondFactorRepository::createSearchQuery',
126		is_object($stringStatus) ? get_class($stringStatus) : (string) $stringStatus
127		));
128		}
129
130		// we need to resolve the string value to database value using the correct doctrine type. Normally this is
131		// done by doctrine itself, however the queries PagerFanta creates somehow manages to mangle this...
132		// so we do it by hand
133		$doctrineType = Type::getType(SecondFactorStatusType::NAME);
134		$secondFactorStatus = SecondFactorStatus::$stringStatus();
135
136		$databaseValue = $doctrineType->convertToDatabaseValue(
137		$secondFactorStatus,
138		$this->getEntityManager()->getConnection()->getDatabasePlatform()
139		);
140
141		$queryBuilder->andWhere('sf.status = :status')->setParameter('status', $databaseValue);
142		}
143
144		switch ($query->orderBy) {
145		case 'name':
146		case 'type':
147		case 'secondFactorId':
148		case 'email':
149		case 'institution':
150		case 'status':
151		$queryBuilder->orderBy(
152		sprintf('sf.%s', $query->orderBy),
153		$query->orderDirection === 'desc' ? 'DESC' : 'ASC'
154		);
155		break;
156		}
157
158		return $queryBuilder->getQuery();
159		}
160
161		/**
162		* @param IdentityId $identityId
163		* @return void
164		*/
165	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...
166		{
167		$this->getEntityManager()->createQueryBuilder()
168		->delete($this->_entityName, 'rasf')
169		->where('rasf.identityId = :identityId')
170		->setParameter('identityId', $identityId->getIdentityId())
171		->getQuery()
172		->execute();
173		}
174
175		public function save(RaSecondFactor $secondFactor)
176		{
177		$this->getEntityManager()->persist($secondFactor);
178		$this->getEntityManager()->flush();
179		}
180
181		/**
182		* @param RaSecondFactor[] $secondFactors
183		*/
184		public function saveAll(array $secondFactors)
185		{
186		$entityManager = $this->getEntityManager();
187
188		foreach ($secondFactors as $secondFactor) {
189		$entityManager->persist($secondFactor);
190		}
191
192		$entityManager->flush();
193		}
194		}
195

OpenConext / Stepup-Middleware

Pull Request — develop (#261)

RaSecondFactorRepository::createSearchQuery() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like