Registry::resetOrClearManager() - Code Metrics - Inspection of "Merge pull request #1109 from doctrine/2.0.x-merge..." - doctrine/DoctrineBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2a073d...f87602 )

by Andreas

created 2019-12-19 14:31 UTC

Registry::resetOrClearManager() A

↳ Parent: Registry

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	3
nc	3
nop	2

<?php

namespace Doctrine\Bundle\DoctrineBundle;

use Doctrine\ORM\ORMException;
use ProxyManager\Proxy\LazyLoadingInterface;
use Psr\Container\ContainerInterface;
use Symfony\Bridge\Doctrine\ManagerRegistry;
use Symfony\Contracts\Service\ResetInterface;

/**
 * References all Doctrine connections and entity managers in a given Container.
 */
class Registry extends ManagerRegistry implements ResetInterface
{
    /**
     * @param string[] $connections
     * @param string[] $entityManagers
     * @param string   $defaultConnection
     * @param string   $defaultEntityManager
     */
    public function __construct(ContainerInterface $container, array $connections, array $entityManagers, $defaultConnection, $defaultEntityManager)
    {
        $this->container = $container;
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;
}

        parent::__construct('ORM', $connections, $entityManagers, $defaultConnection, $defaultEntityManager, 'Doctrine\ORM\Proxy\Proxy');
    }

    /**
     * Resolves a registered namespace alias to the full namespace.
     *
     * This method looks for the alias in all registered entity managers.
     *
     * @see Configuration::getEntityNamespace
     *
     * @param string $alias The alias
     *
     * @return string The full namespace
     */
    public function getAliasNamespace($alias)
    {
        foreach (array_keys($this->getManagers()) as $name) {
            try {
                return $this->getManager($name)->getConfiguration()->getEntityNamespace($alias);
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.
    }
}
            } catch (ORMException $e) {

            }
        }

        throw ORMException::unknownEntityNamespace($alias);
    }

    public function reset() : void
    {
        foreach ($this->getManagerNames() as $managerName => $serviceId) {
            $this->resetOrClearManager($managerName, $serviceId);
        }
    }

    private function resetOrClearManager(string $managerName, string $serviceId) : void
    {
        if (! $this->container->initialized($serviceId)) {
            return;
        }

        $manager = $this->container->get($serviceId);

        if (! $manager instanceof LazyLoadingInterface) {
            $manager->clear();

            return;
        }

        $this->resetManager($managerName);
    }
}


1			<?php
2
3			namespace Doctrine\Bundle\DoctrineBundle;
4
5			use Doctrine\ORM\ORMException;
6			use ProxyManager\Proxy\LazyLoadingInterface;
7			use Psr\Container\ContainerInterface;
8			use Symfony\Bridge\Doctrine\ManagerRegistry;
9			use Symfony\Contracts\Service\ResetInterface;
10
11			/**
12			* References all Doctrine connections and entity managers in a given Container.
13			*/
14			class Registry extends ManagerRegistry implements ResetInterface
15			{
16			/**
17			* @param string[] $connections
18			* @param string[] $entityManagers
19			* @param string $defaultConnection
20			* @param string $defaultEntityManager
21			*/
22			public function __construct(ContainerInterface $container, array $connections, array $entityManagers, $defaultConnection, $defaultEntityManager)
23			{
24			$this->container = $container;
			0 ignored issues – show Documentation Bug introduced 2019-03-13 15:58 UTC by Report Bug Copy Issue Report `$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...
25
26			parent::__construct('ORM', $connections, $entityManagers, $defaultConnection, $defaultEntityManager, 'Doctrine\ORM\Proxy\Proxy');
27			}
28
29			/**
30			* Resolves a registered namespace alias to the full namespace.
31			*
32			* This method looks for the alias in all registered entity managers.
33			*
34			* @see Configuration::getEntityNamespace
35			*
36			* @param string $alias The alias
37			*
38			* @return string The full namespace
39			*/
40			public function getAliasNamespace($alias)
41			{
42			foreach (array_keys($this->getManagers()) as $name) {
43			try {
44			return $this->getManager($name)->getConfiguration()->getEntityNamespace($alias);
			0 ignored issues – show Bug introduced 2019-12-18 14:41 UTC by Report Bug Copy Issue Report 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 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45			} catch (ORMException $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-03-22 12:29 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
46			}
47			}
48
49			throw ORMException::unknownEntityNamespace($alias);
50			}
51
52			public function reset() : void
53			{
54			foreach ($this->getManagerNames() as $managerName => $serviceId) {
55			$this->resetOrClearManager($managerName, $serviceId);
56			}
57			}
58
59			private function resetOrClearManager(string $managerName, string $serviceId) : void
60			{
61			if (! $this->container->initialized($serviceId)) {
62			return;
63			}
64
65			$manager = $this->container->get($serviceId);
66
67			if (! $manager instanceof LazyLoadingInterface) {
68			$manager->clear();
69
70			return;
71			}
72
73			$this->resetManager($managerName);
74			}
75			}
76

doctrine / DoctrineBundle

Push — master ( 2a073d...f87602 )

Registry::resetOrClearManager() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like