ORMBusinessEntityResolver::searchBusinessEntities() - Code Metrics - Inspection of "API mode" - Victoire/victoire - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#812)

by Paul

created 2017-03-13 17:46 UTC

searchBusinessEntities() A

↳ Parent: ORMBusinessEntityResolver

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
rs	9.4285
cc	1
eloc	8
nc	1
nop	3

<?php

namespace Victoire\Bundle\ORMBusinessEntityBundle\Resolver;

use Doctrine\ORM\EntityManager;
use Victoire\Bundle\BusinessEntityBundle\Entity\BusinessProperty;
use Victoire\Bundle\BusinessEntityBundle\Resolver\BusinessEntityResolverInterface;
use Victoire\Bundle\CoreBundle\Entity\EntityProxy;
use Victoire\Bundle\ORMBusinessEntityBundle\Entity\ORMBusinessEntity;

/**
 * Class ORMBusinessEntityResolver.
 */
class ORMBusinessEntityResolver implements BusinessEntityResolverInterface
{
    protected $entityManager;

    public function __construct(EntityManager $entityManager)
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->entityManager = $entityManager;
    }

    public function getBusinessEntity(EntityProxy $entityProxy)
    {
        return $this->entityManager->getRepository($entityProxy->getBusinessEntity()->getClass())
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.
    }
}
            ->findOneById($entityProxy->getRessourceId());
    }

    public function getBusinessEntities(ORMBusinessEntity $businessEntity)
    {
        return $this->entityManager->getRepository($businessEntity->getClass())
            ->findAll();
    }

    /**
     * filter repo to get a list of entities.
     *
     * @param ORMBusinessEntity $businessEntity
     * @param array             $filters
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return mixed
     */
    public function searchBusinessEntities(ORMBusinessEntity $businessEntity, BusinessProperty $businessProperty, $filter)
    {
        $alias = $businessEntity->getName();

        return $this->entityManager->getRepository($businessEntity->getClass())
            ->createQueryBuilder($alias)
            ->where($alias.'.'.$businessProperty->getName().'LIKE %:filter%')
            ->setParameter(':filter', $filter)
            ->getQuery()
            ->getResult();
    }
}


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 2017-03-08 18:26 UTC by Report Bug Copy Issue Report 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...
19			{
20			$this->entityManager = $entityManager;
21			}
22
23			public function getBusinessEntity(EntityProxy $entityProxy)
24			{
25			return $this->entityManager->getRepository($entityProxy->getBusinessEntity()->getClass())
			0 ignored issues – show Bug introduced 2017-03-08 18:26 UTC by Report Bug Copy Issue Report 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 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 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)
30			{
31			return $this->entityManager->getRepository($businessEntity->getClass())
32			->findAll();
33			}
34
35			/**
36			* filter repo to get a list of entities.
37			*
38			* @param ORMBusinessEntity $businessEntity
39			* @param array $filters
			0 ignored issues – show Documentation introduced 2017-03-08 18:26 UTC by Report Bug Copy Issue Report There is no parameter named `$filters`. Did you maybe mean `$filter`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. 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

Victoire / victoire

Pull Request — master (#812)

searchBusinessEntities() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like