Issues in CloneListener.php - All Issues - Inspection of "[NodeBundle] Allow duplicate with children (#2686..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 06c1ce...67d37c )

by Jeroen

created 2020-06-12 09:11 UTC

SeoBundle/EventListener/CloneListener.php (2 issues)

Labels

Bug 2

Severity

Minor 2

Daan Poron 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\SeoBundle\EventListener;

use Doctrine\ORM\EntityManager;
use Kunstmaan\AdminBundle\Entity\AbstractEntity;
use Kunstmaan\AdminBundle\Event\DeepCloneAndSaveEvent;
use Kunstmaan\AdminBundle\Helper\CloneHelper;
use Kunstmaan\SeoBundle\Entity\Seo;

/**
 * This event will make sure the seo metadata is copied when a page is cloned
 */
class CloneListener
{
    /**
     * @var EntityManager
     */
    private $em;

    /**
     * @var CloneHelper
     */
    private $cloneHelper;

    /**
     * @param EntityManager $em          The entity manager
     * @param CloneHelper   $cloneHelper The clone helper
     */
    public function __construct(EntityManager $em, CloneHelper $cloneHelper)
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
    {
        $this->em = $em;
        $this->cloneHelper = $cloneHelper;
    }

    /**
     * @param DeepCloneAndSaveEvent $event
     */
    public function postDeepCloneAndSave(DeepCloneAndSaveEvent $event)
    {
        $originalEntity = $event->getEntity();

        if ($originalEntity instanceof AbstractEntity) {
            /* @var Seo $seo */
            $seo = $this->em->getRepository('KunstmaanSeoBundle:Seo')->findFor($originalEntity);
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.
    }
}

            if (!\is_null($seo)) {
                /* @var Seo $clonedSeo */
                $clonedSeo = $this->cloneHelper->deepCloneAndSave($seo);
                $clonedSeo->setRef($event->getClonedEntity());

                $this->em->persist($clonedSeo);
                $this->em->flush($clonedSeo);
            }
        }
    }
}


1			<?php
2
3			namespace Kunstmaan\SeoBundle\EventListener;
4
5			use Doctrine\ORM\EntityManager;
6			use Kunstmaan\AdminBundle\Entity\AbstractEntity;
7			use Kunstmaan\AdminBundle\Event\DeepCloneAndSaveEvent;
8			use Kunstmaan\AdminBundle\Helper\CloneHelper;
9			use Kunstmaan\SeoBundle\Entity\Seo;
10
11			/**
12			* This event will make sure the seo metadata is copied when a page is cloned
13			*/
14			class CloneListener
15			{
16			/**
17			* @var EntityManager
18			*/
19			private $em;
20
21			/**
22			* @var CloneHelper
23			*/
24			private $cloneHelper;
25
26			/**
27			* @param EntityManager $em The entity manager
28			* @param CloneHelper $cloneHelper The clone helper
29			*/
30			public function __construct(EntityManager $em, CloneHelper $cloneHelper)
			0 ignored issues – show Bug introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report Show Similar Issues like this You have injected the EntityManager via parameter `$em`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
31			{
32			$this->em = $em;
33			$this->cloneHelper = $cloneHelper;
34			}
35
36			/**
37			* @param DeepCloneAndSaveEvent $event
38			*/
39			public function postDeepCloneAndSave(DeepCloneAndSaveEvent $event)
40			{
41			$originalEntity = $event->getEntity();
42
43			if ($originalEntity instanceof AbstractEntity) {
44			/* @var Seo $seo */
45			$seo = $this->em->getRepository('KunstmaanSeoBundle:Seo')->findFor($originalEntity);
			0 ignored issues – show Bug introduced 2020-06-11 21:21 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 `findFor()` does only exist in the following implementations of said interface: `Kunstmaan\PagePartBundle...ConfigurationRepository`, `Kunstmaan\SeoBundle\Repository\SeoRepository`. 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...
46
47			if (!\is_null($seo)) {
48			/* @var Seo $clonedSeo */
49			$clonedSeo = $this->cloneHelper->deepCloneAndSave($seo);
50			$clonedSeo->setRef($event->getClonedEntity());
51
52			$this->em->persist($clonedSeo);
53			$this->em->flush($clonedSeo);
54			}
55			}
56			}
57			}
58

Kunstmaan / KunstmaanBundlesCMS

Push — master ( 06c1ce...67d37c )

SeoBundle/EventListener/CloneListener.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like