Issues in AnalyticsSegmentRepository.php - New Issues - Inspection of "Merge pull request #2662 from acrobat/replace-doct..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d6774...64f3ed )

by Jeroen

created 2020-06-25 11:41 UTC

Repository/AnalyticsSegmentRepository.php (2 issues)

Labels

Bug 2

Severity

Minor 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Kunstmaan\DashboardBundle\Repository;

use Doctrine\ORM\EntityRepository;
use Kunstmaan\DashboardBundle\Entity\AnalyticsConfig;

/**
 * AnalyticsSegmentRepository
 *
 * This class was generated by the Doctrine ORM. Add your own custom
 * repository methods below.
 */
class AnalyticsSegmentRepository extends EntityRepository
{
    /**
     * Get a segment
     *
     * @param int $id
     *
     * @return AnalyticsOverview|bool
     */
    public function deleteSegment($id)
    {
        $em = $this->getEntityManager();
        $qb = $em->createQueryBuilder();
        $qb->select('s')
            ->from('KunstmaanDashboardBundle:AnalyticsSegment', 's')
            ->where('s.id = :id')
            ->setParameter('id', $id);

        $results = $qb->getQuery()->getResult();
        if ($results) {
            $em->remove($results[0]);
            $em->flush();
        }
    }

    /**
     * Initialise a segment by adding new overviews if they don't exist yet
     *
     * @param AnalyticsSegment $segment
     * @param int              $configId
     */
    public function initSegment($segment, $configId = false)
    {
        if (!\count($segment->getOverviews()->toArray())) {
            if ($configId) {
                $config = $this->getEntityManager()->getRepository(AnalyticsConfig::class)->find($configId);
            } else {
                $config = $this->getEntityManager()->getRepository(AnalyticsConfig::class)->findFirst();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            }
            $this->getEntityManager()->getRepository(AnalyticsOverview::class)->addOverviews($config, $segment);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }
}


1			<?php
2
3			namespace Kunstmaan\DashboardBundle\Repository;
4
5			use Doctrine\ORM\EntityRepository;
6			use Kunstmaan\DashboardBundle\Entity\AnalyticsConfig;
7
8			/**
9			* AnalyticsSegmentRepository
10			*
11			* This class was generated by the Doctrine ORM. Add your own custom
12			* repository methods below.
13			*/
14			class AnalyticsSegmentRepository extends EntityRepository
15			{
16			/**
17			* Get a segment
18			*
19			* @param int $id
20			*
21			* @return AnalyticsOverview\|bool
22			*/
23			public function deleteSegment($id)
24			{
25			$em = $this->getEntityManager();
26			$qb = $em->createQueryBuilder();
27			$qb->select('s')
28			->from('KunstmaanDashboardBundle:AnalyticsSegment', 's')
29			->where('s.id = :id')
30			->setParameter('id', $id);
31
32			$results = $qb->getQuery()->getResult();
33			if ($results) {
34			$em->remove($results[0]);
35			$em->flush();
36			}
37			}
38
39			/**
40			* Initialise a segment by adding new overviews if they don't exist yet
41			*
42			* @param AnalyticsSegment $segment
43			* @param int $configId
44			*/
45			public function initSegment($segment, $configId = false)
46			{
47			if (!\count($segment->getOverviews()->toArray())) {
48			if ($configId) {
49			$config = $this->getEntityManager()->getRepository(AnalyticsConfig::class)->find($configId);
50			} else {
51			$config = $this->getEntityManager()->getRepository(AnalyticsConfig::class)->findFirst();
			0 ignored issues – show Bug introduced 2020-06-25 11:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Doctrine\Persistence\ObjectRepository` as the method `findFirst()` does only exist in the following implementations of said interface: `Kunstmaan\DashboardBundl...alyticsConfigRepository`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
52			}
53			$this->getEntityManager()->getRepository(AnalyticsOverview::class)->addOverviews($config, $segment);
			0 ignored issues – show Bug introduced 2020-06-25 11:52 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Doctrine\Persistence\ObjectRepository` as the method `addOverviews()` does only exist in the following implementations of said interface: `Kunstmaan\DashboardBundl...yticsOverviewRepository`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
54			}
55			}
56			}
57

Kunstmaan / KunstmaanBundlesCMS

Push — master ( 6d6774...64f3ed )

Repository/AnalyticsSegmentRepository.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like