MassUpdater   A
last analyzed

Complexity

Total Complexity 3

Size/Duplication

Total Lines 37
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1
Metric Value
wmc 3
lcom 1
cbo 1
dl 0
loc 37
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A updateEntities() 0 12 2
1
<?php
2
3
namespace Pim\Bundle\CustomEntityBundle\MassAction;
4
5
use Symfony\Bridge\Doctrine\RegistryInterface;
6
7
/**
8
 * Mass action updater
9
 *
10
 * @author    Antoine Guigan <[email protected]>
11
 * @copyright 2013 Akeneo SAS (http://www.akeneo.com)
12
 * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
13
 */
14
class MassUpdater
15
{
16
    /**
17
     * @var RegistryInterface
18
     */
19
    protected $doctrine;
20
21
    /**
22
     * Constructor
23
     *
24
     * @param RegistryInterface $doctrine
25
     */
26
    public function __construct(RegistryInterface $doctrine)
27
    {
28
        $this->doctrine = $doctrine;
29
    }
30
31
    /**
32
     * Mass updates entities
33
     *
34
     * @param string $class
35
     * @param array  $data
36
     * @param array  $ids
37
     */
38
    public function updateEntities($class, array $data, array $ids)
39
    {
40
        $qb = $this->doctrine->getManager()->createQueryBuilder()
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method createQueryBuilder() does only exist in the following implementations of said interface: Doctrine\ORM\Decorator\EntityManagerDecorator, Doctrine\ORM\EntityManager.

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

  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 interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
41
            ->update($class, 'o')
42
            ->where('o.id IN (:ids)')
43
            ->setParameter('ids', $ids);
44
        foreach ($data as $key => $value) {
45
            $qb->set("o.$key", ":$key")->setParameter(":$key", $value);
46
        }
47
48
        $qb->getQuery()->execute();
49
    }
50
}
51