ORMBusinessEntityResolver::getBusinessEntity()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 5
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
nc 1
nop 1
1
<?php
2
3
namespace Victoire\Bundle\ORMBusinessEntityBundle\Resolver;
4
5
use Doctrine\ORM\EntityManager;
6
use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessProperty;
7
use Victoire\Bundle\BusinessEntityBundle\Resolver\BusinessEntityResolverInterface;
8
use Victoire\Bundle\CoreBundle\Entity\EntityProxy;
9
use Victoire\Bundle\ORMBusinessEntityBundle\Entity\ORMBusinessEntity;
10
11
/**
12
 * Class ORMBusinessEntityResolver.
13
 */
14
class ORMBusinessEntityResolver implements BusinessEntityResolverInterface
15
{
16
    protected $entityManager;
17
18
    public function __construct(EntityManager $entityManager)
0 ignored issues
show
Bug introduced by
You have injected the EntityManager via parameter $entityManager. 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...
introduced by
Missing function doc comment
Loading history...
19
    {
20
        $this->entityManager = $entityManager;
21
    }
22
23
    public function getBusinessEntity(EntityProxy $entityProxy)
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
24
    {
25
        return $this->entityManager->getRepository($entityProxy->getBusinessEntity()->getClass())
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Victoire\Bundle\Business...e\Entity\BusinessEntity as the method getClass() does only exist in the following sub-classes of Victoire\Bundle\Business...e\Entity\BusinessEntity: Victoire\Bundle\ORMBusin...ntity\ORMBusinessEntity. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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 sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
26
            ->findOneById($entityProxy->getRessourceId());
27
    }
28
29
    public function getBusinessEntities(ORMBusinessEntity $businessEntity)
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
30
    {
31
        return $this->entityManager->getRepository($businessEntity->getClass())
32
            ->findAll();
33
    }
34
35
    /**
0 ignored issues
show
introduced by
Doc comment for parameter "$businessProperty" missing
Loading history...
36
     * filter repo to get a list of entities.
37
     *
38
     * @param ORMBusinessEntity $businessEntity
39
     * @param array             $filter
0 ignored issues
show
introduced by
Doc comment for parameter $filter does not match actual variable name $businessProperty
Loading history...
40
     *
41
     * @return mixed
42
     */
43
    public function searchBusinessEntities(ORMBusinessEntity $businessEntity, BusinessProperty $businessProperty, $filter)
44
    {
45
        $alias = $businessEntity->getName();
46
47
        return $this->entityManager->getRepository($businessEntity->getClass())
48
            ->createQueryBuilder($alias)
49
            ->where($alias.'.'.$businessProperty->getName().'LIKE %:filter%')
50
            ->setParameter(':filter', $filter)
51
            ->getQuery()
52
            ->getResult();
53
    }
54
}
55