Completed
Pull Request — master (#1101)
by
unknown
16:28
created

Registry.php (2 issues)

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

1
<?php
2
3
namespace Doctrine\Bundle\DoctrineBundle;
4
5
use Doctrine\ORM\ORMException;
6
use Psr\Container\ContainerInterface;
7
use Symfony\Bridge\Doctrine\ManagerRegistry;
8
use Symfony\Contracts\Service\ResetInterface;
9
10
/**
11
 * References all Doctrine connections and entity managers in a given Container.
12
 */
13
class Registry extends ManagerRegistry implements ResetInterface
14
{
15
    /**
16
     * @param string[] $connections
17
     * @param string[] $entityManagers
18
     * @param string   $defaultConnection
19
     * @param string   $defaultEntityManager
20
     */
21
    public function __construct(ContainerInterface $container, array $connections, array $entityManagers, $defaultConnection, $defaultEntityManager)
22
    {
23
        $this->container = $container;
24
25
        parent::__construct('ORM', $connections, $entityManagers, $defaultConnection, $defaultEntityManager, 'Doctrine\ORM\Proxy\Proxy');
26
    }
27
28
    /**
29
     * Resolves a registered namespace alias to the full namespace.
30
     *
31
     * This method looks for the alias in all registered entity managers.
32
     *
33
     * @see Configuration::getEntityNamespace
34
     *
35
     * @param string $alias The alias
36
     *
37
     * @return string The full namespace
38
     */
39
    public function getAliasNamespace($alias)
40
    {
41
        foreach (array_keys($this->getManagers()) as $name) {
42
            try {
43
                return $this->getManager($name)->getConfiguration()->getEntityNamespace($alias);
0 ignored issues
show
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...
44
            } catch (ORMException $e) {
0 ignored issues
show
Coding Style Comprehensibility introduced by
Consider adding a comment why this CATCH block is empty.
Loading history...
45
            }
46
        }
47
48
        throw ORMException::unknownEntityNamespace($alias);
49
    }
50
51
    public function reset() : void
52
    {
53
        foreach ($this->getManagerNames() as $managerName) {
54
            $this->resetManager($managerName);
55
        }
56
    }
57
}
58