RaSecondFactorRepository::createSearchQuery() - Code Metrics - Inspection of "Merge pull request #242 from OpenConext/feature/fg..." - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/fine-grained-authoriza... ( e1bd5c...a0b49e )

by Michiel

created 2018-10-11 13:44 UTC

RaSecondFactorRepository::createSearchQuery() C

↳ Parent: RaSecondFactorRepository

Complexity

Conditions	14
Paths	208

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	64
rs	5.3333
c	0
b	0
f	0
cc	14
nc	208
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();
    }
}
    }

    /**
     * @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->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 '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		* @SuppressWarnings(PHPMD.CyclomaticComplexity) The amount of if statements do not necessarily make the method
74		* below complex or hard to maintain.
75		* @SuppressWarnings(PHPMD.NPathComplexity)
76		*
77		* @param RaSecondFactorQuery $query
78		* @return Query
79		* @throws \Doctrine\DBAL\DBALException
80		*/
81		public function createSearchQuery(RaSecondFactorQuery $query)
82		{
83		$queryBuilder = $this
84		->createQueryBuilder('sf');
85
86		// Modify query to filter on authorization
87		$this->authorizationRepositoryFilter->filter($queryBuilder, $query->authorizationContext, 'sf.id', 'sf.institution', 'iac');
88
89		if ($query->name) {
90		$queryBuilder->andWhere('sf.name LIKE :name')->setParameter('name', sprintf('%%%s%%', $query->name));
91		}
92
93		if ($query->type) {
94		$queryBuilder->andWhere('sf.type = :type')->setParameter('type', $query->type);
95		}
96
97		if ($query->secondFactorId) {
98		$queryBuilder
99		->andWhere('sf.secondFactorId = :secondFactorId')
100		->setParameter('secondFactorId', $query->secondFactorId);
101		}
102
103		if ($query->email) {
104		$queryBuilder->andWhere('sf.email LIKE :email')->setParameter('email', sprintf('%%%s%%', $query->email));
105		}
106
107		if ($query->status) {
108		$stringStatus = $query->status;
109		if (!SecondFactorStatus::isValidStatus($stringStatus)) {
110		throw new RuntimeException(sprintf(
111		'Received invalid status "%s" in RaSecondFactorRepository::createSearchQuery',
112		is_object($stringStatus) ? get_class($stringStatus) : (string) $stringStatus
113		));
114		}
115
116		// we need to resolve the string value to database value using the correct doctrine type. Normally this is
117		// done by doctrine itself, however the queries PagerFanta creates somehow manages to mangle this...
118		// so we do it by hand
119		$doctrineType = Type::getType(SecondFactorStatusType::NAME);
120		$secondFactorStatus = SecondFactorStatus::$stringStatus();
121
122		$databaseValue = $doctrineType->convertToDatabaseValue(
123		$secondFactorStatus,
124		$this->getEntityManager()->getConnection()->getDatabasePlatform()
125		);
126
127		$queryBuilder->andWhere('sf.status = :status')->setParameter('status', $databaseValue);
128		}
129
130		switch ($query->orderBy) {
131		case 'name':
132		case 'type':
133		case 'secondFactorId':
134		case 'email':
135		case 'status':
136		$queryBuilder->orderBy(
137		sprintf('sf.%s', $query->orderBy),
138		$query->orderDirection === 'desc' ? 'DESC' : 'ASC'
139		);
140		break;
141		}
142
143		return $queryBuilder->getQuery();
144		}
145
146		/**
147		* @param IdentityId $identityId
148		* @return void
149		*/
150	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...
151		{
152		$this->getEntityManager()->createQueryBuilder()
153		->delete($this->_entityName, 'rasf')
154		->where('rasf.identityId = :identityId')
155		->setParameter('identityId', $identityId->getIdentityId())
156		->getQuery()
157		->execute();
158		}
159
160		public function save(RaSecondFactor $secondFactor)
161		{
162		$this->getEntityManager()->persist($secondFactor);
163		$this->getEntityManager()->flush();
164		}
165
166		/**
167		* @param RaSecondFactor[] $secondFactors
168		*/
169		public function saveAll(array $secondFactors)
170		{
171		$entityManager = $this->getEntityManager();
172
173		foreach ($secondFactors as $secondFactor) {
174		$entityManager->persist($secondFactor);
175		}
176
177		$entityManager->flush();
178		}
179		}
180

OpenConext / Stepup-Middleware

Push — feature/fine-grained-authoriza... ( e1bd5c...a0b49e )

RaSecondFactorRepository::createSearchQuery() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like