RaSecondFactorRepository::findByInstitution() - Code Metrics - Inspection of "Add filter options to pagination results" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#270)

unknown

created 2019-03-05 11:32 UTC

RaSecondFactorRepository::findByInstitution() A

↳ Parent: RaSecondFactorRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?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
        // The SRAA user does not adhere to the FGA filter rules when searching for tokens
        if (!$query->authorizationContext->isActorSraa()) {
            $this->authorizationRepositoryFilter->filter(
                $queryBuilder,
                $query->authorizationContext,
                '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 RaSecondFactorQuery $query
     * @return \Doctrine\ORM\Query
     */
    public function createOptionsQuery(RaSecondFactorQuery $query)
    {
        $queryBuilder = $this->createQueryBuilder('sf')
            ->select('sf.institution')
            ->groupBy('sf.institution');

        // Modify query to filter on authorization
        // The SRAA user does not adhere to the FGA filter rules when searching for tokens
        if (!$query->authorizationContext->isActorSraa()) {
            $this->authorizationRepositoryFilter->filter(
                $queryBuilder,
                $query->authorizationContext,
                'sf.institution',
                'iac'
            );
        }

        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			// The SRAA user does not adhere to the FGA filter rules when searching for tokens
98			if (!$query->authorizationContext->isActorSraa()) {
99			$this->authorizationRepositoryFilter->filter(
100			$queryBuilder,
101			$query->authorizationContext,
102			'sf.institution',
103			'iac'
104			);
105			}
106
107			if ($query->name) {
108			$queryBuilder->andWhere('sf.name LIKE :name')->setParameter('name', sprintf('%%%s%%', $query->name));
109			}
110
111			if ($query->type) {
112			$queryBuilder->andWhere('sf.type = :type')->setParameter('type', $query->type);
113			}
114
115			if ($query->secondFactorId) {
116			$queryBuilder
117			->andWhere('sf.secondFactorId = :secondFactorId')
118			->setParameter('secondFactorId', $query->secondFactorId);
119			}
120
121			if ($query->email) {
122			$queryBuilder->andWhere('sf.email LIKE :email')->setParameter('email', sprintf('%%%s%%', $query->email));
123			}
124
125			if ($query->institution) {
126			$queryBuilder->andWhere('sf.institution = :institution')->setParameter('institution', $query->institution);
127			}
128
129			if ($query->status) {
130			$stringStatus = $query->status;
131			if (!SecondFactorStatus::isValidStatus($stringStatus)) {
132			throw new RuntimeException(sprintf(
133			'Received invalid status "%s" in RaSecondFactorRepository::createSearchQuery',
134			is_object($stringStatus) ? get_class($stringStatus) : (string) $stringStatus
135			));
136			}
137
138			// we need to resolve the string value to database value using the correct doctrine type. Normally this is
139			// done by doctrine itself, however the queries PagerFanta creates somehow manages to mangle this...
140			// so we do it by hand
141			$doctrineType = Type::getType(SecondFactorStatusType::NAME);
142			$secondFactorStatus = SecondFactorStatus::$stringStatus();
143
144			$databaseValue = $doctrineType->convertToDatabaseValue(
145			$secondFactorStatus,
146			$this->getEntityManager()->getConnection()->getDatabasePlatform()
147			);
148
149			$queryBuilder->andWhere('sf.status = :status')->setParameter('status', $databaseValue);
150			}
151
152			switch ($query->orderBy) {
153			case 'name':
154			case 'type':
155			case 'secondFactorId':
156			case 'email':
157			case 'institution':
158			case 'status':
159			$queryBuilder->orderBy(
160			sprintf('sf.%s', $query->orderBy),
161			$query->orderDirection === 'desc' ? 'DESC' : 'ASC'
162			);
163			break;
164			}
165
166			return $queryBuilder->getQuery();
167			}
168
169			/**
170			* @param RaSecondFactorQuery $query
171			* @return \Doctrine\ORM\Query
172			*/
173			public function createOptionsQuery(RaSecondFactorQuery $query)
174			{
175			$queryBuilder = $this->createQueryBuilder('sf')
176			->select('sf.institution')
177			->groupBy('sf.institution');
178
179			// Modify query to filter on authorization
180			// The SRAA user does not adhere to the FGA filter rules when searching for tokens
181			if (!$query->authorizationContext->isActorSraa()) {
182			$this->authorizationRepositoryFilter->filter(
183			$queryBuilder,
184			$query->authorizationContext,
185			'sf.institution',
186			'iac'
187			);
188			}
189
190			return $queryBuilder->getQuery();
191			}
192
193			/**
194			* @param IdentityId $identityId
195			* @return void
196			*/
197			public function removeByIdentityId(IdentityId $identityId)
198			{
199			$this->getEntityManager()->createQueryBuilder()
200			->delete($this->_entityName, 'rasf')
201			->where('rasf.identityId = :identityId')
202			->setParameter('identityId', $identityId->getIdentityId())
203			->getQuery()
204			->execute();
205			}
206
207			public function save(RaSecondFactor $secondFactor)
208			{
209			$this->getEntityManager()->persist($secondFactor);
210			$this->getEntityManager()->flush();
211			}
212
213			/**
214			* @param RaSecondFactor[] $secondFactors
215			*/
216			public function saveAll(array $secondFactors)
217			{
218			$entityManager = $this->getEntityManager();
219
220			foreach ($secondFactors as $secondFactor) {
221			$entityManager->persist($secondFactor);
222			}
223
224			$entityManager->flush();
225			}
226			}
227

OpenConext / Stepup-Middleware

Pull Request — develop (#270)

RaSecondFactorRepository::findByInstitution() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like