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

Completed

Push — feature/fine-grained-authoriza... ( 479a18...68ddb3 )

unknown

created 2018-10-31 16:17 UTC

RaListingRepository::createSearchQuery() B

↳ Parent: RaListingRepository

Complexity

Conditions	6
Paths	20

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	41
rs	8.6417
c	0
b	0
f	0
cc	6
nc	20
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\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\Exception\RuntimeException;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Entity\RaListing;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Query\RaListingQuery;

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::findOneBy(['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 $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();
    }

    /**
     * @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.identityId', 'r.institution', 'r.raInstitution'],
            'r.institution',
            '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->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\Exception\RuntimeException;
29		use Surfnet\StepupMiddleware\ApiBundle\Identity\Entity\RaListing;
30		use Surfnet\StepupMiddleware\ApiBundle\Identity\Query\RaListingQuery;
31
32		class RaListingRepository extends EntityRepository
33		{
34		/**
35		* @var InstitutionAuthorizationRepositoryFilter
36		*/
37		private $authorizationRepositoryFilter;
38
39		public function __construct(
40		EntityManager $em,
41		Mapping\ClassMetadata $class,
42		InstitutionAuthorizationRepositoryFilter $authorizationRepositoryFilter
43		) {
44		parent::__construct($em, $class);
45		$this->authorizationRepositoryFilter = $authorizationRepositoryFilter;
46		}
47
48		/**
49		* @param IdentityId $identityId The RA's identity id.
50		* @return null\|RaListing
		0 ignored issues – show Documentation introduced 2015-12-15 13:40 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...
51		*/
52		public function findByIdentityId(IdentityId $identityId)
53		{
54		return parent::findOneBy(['identityId' => (string) $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 (`findOneBy()` instead of `findByIdentityId()`). 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...
55		}
56
57		/**
58		* @param IdentityId $identityId The RA's identity id.
59		* @param Institution $raInstitution
60		* @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...
61		*/
62		public function findByIdentityIdAndRaInstitution(IdentityId $identityId, Institution $raInstitution)
63		{
64		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...
65		'identityId' => (string) $identityId,
66		'raInstitution' => (string) $raInstitution,
67		]);
68		}
69
70		/**
71		* @param IdentityId $identityId The RA's identity id.
72		* @param Institution $institution
73		* @return RaListing[]
74		*/
75		public function findByIdentityIdAndInstitution(IdentityId $identityId, Institution $institution)
76		{
77		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...
78		'identityId' => (string) $identityId,
79		'institution' => (string) $institution,
80		]);
81		}
82
83		public function save(RaListing $raListingEntry)
84		{
85		$this->getEntityManager()->persist($raListingEntry);
86		$this->getEntityManager()->flush();
87		}
88
89		/**
90		* @param RaListingQuery $query
91		* @return \Doctrine\ORM\Query
92		*/
93		public function createSearchQuery(RaListingQuery $query)
94		{
95		$queryBuilder = $this->createQueryBuilder('r');
96
97		// Modify query to filter on authorization
98		$this->authorizationRepositoryFilter->filter(
99		$queryBuilder,
100		$query->authorizationContext,
101		['r.identityId', 'r.institution', 'r.raInstitution'],
102		'r.institution',
103		'iac'
104		);
105
106		if ($query->institution) {
107		$queryBuilder
108		->andWhere('r.institution = :institution')
109		->setParameter('institution', $query->institution);
110		}
111
112		if ($query->identityId) {
113		$queryBuilder
114		->andWhere('r.identityId = :identityId')
115		->setParameter('identityId', (string) $query->identityId);
116		}
117
118		if (!$query->orderBy) {
119		return $queryBuilder->getQuery();
120		}
121
122		$orderDirection = $query->orderDirection === 'asc' ? 'ASC' : 'DESC';
123
124		switch ($query->orderBy) {
125		case 'commonName':
126		$queryBuilder->orderBy('r.commonName', $orderDirection);
127		break;
128		default:
129		throw new RuntimeException(sprintf('Unknown order by column "%s"', $query->orderBy));
130		}
131
132		return $queryBuilder->getQuery();
133		}
134
135		/**
136		* @param Institution $raInstitution
137		* @return ArrayCollection
138		*/
139		public function listRasFor(Institution $raInstitution)
140		{
141		$listings = $this->createQueryBuilder('rl')
142		->where('rl.raInstitution = :institution')
143		->setParameter('institution', $raInstitution)
144		->getQuery()
145		->getResult();
146
147		return new ArrayCollection($listings);
148		}
149
150		/**
151		* @param IdentityId $identityId
152		* @return void
153		*/
154	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...
155		{
156		$this->getEntityManager()->createQueryBuilder()
157		->delete($this->_entityName, 'ral')
158		->where('ral.identityId = :identityId')
159		->andWhere('ral.raInstitution = :institution')
160		->setParameter('identityId', $identityId->getIdentityId())
161		->getQuery()
162		->execute();
163		}
164
165		/**
166		* @param IdentityId $identityId
167		* @param Institution $raInstitution
168		* @return void
169		*/
170	View Code Duplication	public function removeByIdentityIdAndRaInstitution(IdentityId $identityId, Institution $raInstitution)
		0 ignored issues – show Duplication introduced 2018-10-23 15:28 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...
171		{
172		$this->getEntityManager()->createQueryBuilder()
173		->delete($this->_entityName, 'ral')
174		->where('ral.identityId = :identityId')
175		->andWhere('ral.raInstitution = :institution')
176		->setParameter('identityId', $identityId->getIdentityId())
177		->setParameter('institution', $raInstitution)
178		->getQuery()
179		->execute();
180		}
181
182		/**
183		* @param IdentityId $identityId
184		* @param Institution $institution
185		* @return void
186		*/
187	View Code Duplication	public function removeByIdentityIdAndInstitution(IdentityId $identityId, Institution $institution)
		0 ignored issues – show Duplication introduced 2018-10-31 14:14 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...
188		{
189		$this->getEntityManager()->createQueryBuilder()
190		->delete($this->_entityName, 'ral')
191		->where('ral.identityId = :identityId')
192		->andWhere('ral.institution = :institution')
193		->setParameter('identityId', $identityId->getIdentityId())
194		->setParameter('institution', $institution)
195		->getQuery()
196		->execute();
197		}
198		}
199

OpenConext / Stepup-Middleware

Push — feature/fine-grained-authoriza... ( 479a18...68ddb3 )

RaListingRepository::createSearchQuery() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like