Registry::reset()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 6
rs 10
c 0
b 0
f 0
cc 2
nc 2
nop 0
1
<?php
2
3
namespace Doctrine\Bundle\DoctrineBundle;
4
5
use Doctrine\ORM\EntityManagerInterface;
6
use Doctrine\ORM\ORMException;
7
use ProxyManager\Proxy\LazyLoadingInterface;
8
use Psr\Container\ContainerInterface;
9
use Symfony\Bridge\Doctrine\ManagerRegistry;
10
use Symfony\Contracts\Service\ResetInterface;
11
12
/**
13
 * References all Doctrine connections and entity managers in a given Container.
14
 */
15
class Registry extends ManagerRegistry implements ResetInterface
16
{
17
    /**
18
     * @param string[] $connections
19
     * @param string[] $entityManagers
20
     * @param string   $defaultConnection
21
     * @param string   $defaultEntityManager
22
     */
23
    public function __construct(ContainerInterface $container, array $connections, array $entityManagers, $defaultConnection, $defaultEntityManager)
24
    {
25
        $this->container = $container;
0 ignored issues
show
Documentation Bug introduced by
$container is of type object<Psr\Container\ContainerInterface>, but the property $container was declared to be of type object<Symfony\Component...ncyInjection\Container>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.

Either this assignment is in error or an instanceof check should be added for that assignment.

class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
Loading history...
26
27
        parent::__construct('ORM', $connections, $entityManagers, $defaultConnection, $defaultEntityManager, 'Doctrine\ORM\Proxy\Proxy');
28
    }
29
30
    /**
31
     * Resolves a registered namespace alias to the full namespace.
32
     *
33
     * This method looks for the alias in all registered entity managers.
34
     *
35
     * @see Configuration::getEntityNamespace
36
     *
37
     * @param string $alias The alias
38
     *
39
     * @return string The full namespace
40
     */
41
    public function getAliasNamespace($alias)
42
    {
43
        foreach (array_keys($this->getManagers()) as $name) {
44
            try {
45
                return $this->getManager($name)->getConfiguration()->getEntityNamespace($alias);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Doctrine\Persistence\ObjectManager as the method getConfiguration() 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...
46
            } catch (ORMException $e) {
0 ignored issues
show
Coding Style Comprehensibility introduced by
Consider adding a comment why this CATCH block is empty.
Loading history...
47
            }
48
        }
49
50
        throw ORMException::unknownEntityNamespace($alias);
51
    }
52
53
    public function reset() : void
54
    {
55
        foreach ($this->getManagerNames() as $managerName => $serviceId) {
56
            $this->resetOrClearManager($managerName, $serviceId);
57
        }
58
    }
59
60
    private function resetOrClearManager(string $managerName, string $serviceId) : void
61
    {
62
        if (! $this->container->initialized($serviceId)) {
63
            return;
64
        }
65
66
        $manager = $this->container->get($serviceId);
67
68
        assert($manager instanceof EntityManagerInterface);
69
70
        if (! $manager instanceof LazyLoadingInterface || $manager->isOpen()) {
71
            $manager->clear();
72
73
            return;
74
        }
75
76
        $this->resetManager($managerName);
77
    }
78
}
79