DoctrineBundle::clearManagerIfRequired() - Code Metrics - Inspection of "Adding support for close and clear on shutdown" - doctrine/DoctrineBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#642)

by COLE

created 2017-03-29 08:23 UTC

DoctrineBundle::clearManagerIfRequired() A

↳ Parent: DoctrineBundle

Complexity

Conditions	4
Paths	3

Size

Total Lines	8
Code Lines	4

Duplication

Lines	8
Ratio	100 %

Importance

Changes

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

<?php

/*
 * This file is part of the Doctrine Bundle
 *
 * The code was originally distributed inside the Symfony framework.
 *
 * (c) Fabien Potencier <[email protected]>
 * (c) Doctrine Project, Benjamin Eberlei <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Doctrine\Bundle\DoctrineBundle;

use Doctrine\Common\Util\ClassUtils;
use Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\Proxy\ImportDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\Proxy\RunSqlDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\EntityListenerPass;
use Doctrine\ORM\Proxy\Autoloader;
use Symfony\Component\Console\Application;
use Symfony\Component\DependencyInjection\Compiler\PassConfig;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\IntrospectableContainerInterface;
use Symfony\Component\HttpKernel\Bundle\Bundle;
use Symfony\Bridge\Doctrine\DependencyInjection\CompilerPass\DoctrineValidationPass;
use Symfony\Bridge\Doctrine\DependencyInjection\CompilerPass\RegisterEventListenersAndSubscribersPass;
use Symfony\Bridge\Doctrine\DependencyInjection\Security\UserProvider\EntityFactory;

/**
 * Bundle.
 *
 * @author Fabien Potencier <[email protected]>
 * @author Jonathan H. Wage <[email protected]>
 */
class DoctrineBundle extends Bundle
{
    private $autoloader;

    /**
     * {@inheritDoc}
     */
    public function build(ContainerBuilder $container)
    {
        parent::build($container);

        $container->addCompilerPass(new RegisterEventListenersAndSubscribersPass('doctrine.connections', 'doctrine.dbal.%s_connection.event_manager', 'doctrine'), PassConfig::TYPE_BEFORE_OPTIMIZATION);

        if ($container->hasExtension('security')) {
            $container->getExtension('security')->addUserProviderFactory(new EntityFactory('entity', 'doctrine.orm.security.user.provider'));

        }

        $container->addCompilerPass(new DoctrineValidationPass('orm'));
        $container->addCompilerPass(new EntityListenerPass());
    }

    /**
     * {@inheritDoc}
     */
    public function boot()
    {
        // Register an autoloader for proxies to avoid issues when unserializing them
        // when the ORM is used.
        if ($this->container->hasParameter('doctrine.orm.proxy_namespace')) {
            $namespace = $this->container->getParameter('doctrine.orm.proxy_namespace');
            $dir = $this->container->getParameter('doctrine.orm.proxy_dir');
            $proxyGenerator = null;

            if ($this->container->getParameter('doctrine.orm.auto_generate_proxy_classes')) {
                // See https://github.com/symfony/symfony/pull/3419 for usage of references
                $container = &$this->container;

                $proxyGenerator = function ($proxyDir, $proxyNamespace, $class) use (&$container) {
                    $originalClassName = ClassUtils::getRealClass($class);
                    /** @var $registry Registry */
                    $registry = $container->get('doctrine');

                    // Tries to auto-generate the proxy file
                    /** @var $em \Doctrine\ORM\EntityManager */
                    foreach ($registry->getManagers() as $em) {
                        if (!$em->getConfiguration()->getAutoGenerateProxyClasses()) {
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.
    }
}
                            continue;
                        }

                        $metadataFactory = $em->getMetadataFactory();

                        if ($metadataFactory->isTransient($originalClassName)) {
                            continue;
                        }

                        $classMetadata = $metadataFactory->getMetadataFor($originalClassName);

                        $em->getProxyFactory()->generateProxyClasses(array($classMetadata));
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.
    }
}

                        clearstatcache(true, Autoloader::resolveFile($proxyDir, $proxyNamespace, $class));

                        break;
                    }
                };
            }

            $this->autoloader = Autoloader::register($dir, $namespace, $proxyGenerator);
        }
    }

    private function clearManagerIfRequired($id)

    {
        if ($this->container->getParameter($id . '.clear_on_shutdown') === true) {
            if (!$this->container instanceof IntrospectableContainerInterface || $this->container->initialized($id)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                $this->container->get($id)->clear();
            }
        }
    }

    private function closeConnectionIfRequired($id)

    {
        if ($this->container->getParameter($id . '.close_on_shutdown') === true) {
            if (!$this->container instanceof IntrospectableContainerInterface || $this->container->initialized($id)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                $this->container->get($id)->close();
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    public function shutdown()
    {
        if (null !== $this->autoloader) {
            spl_autoload_unregister($this->autoloader);
            $this->autoloader = null;
        }

        // Clear all entity managers to clear references to entities for GC
        if ($this->container->hasParameter('doctrine.entity_managers')) {
            foreach ($this->container->getParameter('doctrine.entity_managers') as $id) {
                $this->clearManagerIfRequired($id);
            }
        }

        // Close all connections to avoid reaching too many connections in the process when booting again later (tests)
        if ($this->container->hasParameter('doctrine.connections')) {
            foreach ($this->container->getParameter('doctrine.connections') as $id) {
                $this->closeConnectionIfRequired($id);
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    public function registerCommands(Application $application)
    {
        // Use the default logic when the ORM is available.
        // This avoids listing all ORM commands by hand.
        if (class_exists('Doctrine\\ORM\\Version')) {
            parent::registerCommands($application);

            return;
        }

        // Register only the DBAL commands if the ORM is not available.
        $application->add(new CreateDatabaseDoctrineCommand());
        $application->add(new DropDatabaseDoctrineCommand());
        $application->add(new RunSqlDoctrineCommand());
        $application->add(new ImportDoctrineCommand());
    }
}


1		<?php
2
3		/*
4		* This file is part of the Doctrine Bundle
5		*
6		* The code was originally distributed inside the Symfony framework.
7		*
8		* (c) Fabien Potencier <[email protected]>
9		* (c) Doctrine Project, Benjamin Eberlei <[email protected]>
10		*
11		* For the full copyright and license information, please view the LICENSE
12		* file that was distributed with this source code.
13		*/
14
15		namespace Doctrine\Bundle\DoctrineBundle;
16
17		use Doctrine\Common\Util\ClassUtils;
18		use Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand;
19		use Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand;
20		use Doctrine\Bundle\DoctrineBundle\Command\Proxy\ImportDoctrineCommand;
21		use Doctrine\Bundle\DoctrineBundle\Command\Proxy\RunSqlDoctrineCommand;
22		use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\EntityListenerPass;
23		use Doctrine\ORM\Proxy\Autoloader;
24		use Symfony\Component\Console\Application;
25		use Symfony\Component\DependencyInjection\Compiler\PassConfig;
26		use Symfony\Component\DependencyInjection\ContainerBuilder;
27		use Symfony\Component\DependencyInjection\IntrospectableContainerInterface;
28		use Symfony\Component\HttpKernel\Bundle\Bundle;
29		use Symfony\Bridge\Doctrine\DependencyInjection\CompilerPass\DoctrineValidationPass;
30		use Symfony\Bridge\Doctrine\DependencyInjection\CompilerPass\RegisterEventListenersAndSubscribersPass;
31		use Symfony\Bridge\Doctrine\DependencyInjection\Security\UserProvider\EntityFactory;
32
33		/**
34		* Bundle.
35		*
36		* @author Fabien Potencier <[email protected]>
37		* @author Jonathan H. Wage <[email protected]>
38		*/
39		class DoctrineBundle extends Bundle
40		{
41		private $autoloader;
42
43		/**
44		* {@inheritDoc}
45		*/
46		public function build(ContainerBuilder $container)
47		{
48		parent::build($container);
49
50		$container->addCompilerPass(new RegisterEventListenersAndSubscribersPass('doctrine.connections', 'doctrine.dbal.%s_connection.event_manager', 'doctrine'), PassConfig::TYPE_BEFORE_OPTIMIZATION);
51
52		if ($container->hasExtension('security')) {
53		$container->getExtension('security')->addUserProviderFactory(new EntityFactory('entity', 'doctrine.orm.security.user.provider'));
		0 ignored issues – show Bug introduced 2015-11-24 12:12 UTC by Report Bug Copy Issue Report The method `addUserProviderFactory()` does not seem to exist on `object<Symfony\Component...ion\ExtensionInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
54		}
55
56		$container->addCompilerPass(new DoctrineValidationPass('orm'));
57		$container->addCompilerPass(new EntityListenerPass());
58		}
59
60		/**
61		* {@inheritDoc}
62		*/
63		public function boot()
64		{
65		// Register an autoloader for proxies to avoid issues when unserializing them
66		// when the ORM is used.
67		if ($this->container->hasParameter('doctrine.orm.proxy_namespace')) {
68		$namespace = $this->container->getParameter('doctrine.orm.proxy_namespace');
69		$dir = $this->container->getParameter('doctrine.orm.proxy_dir');
70		$proxyGenerator = null;
71
72		if ($this->container->getParameter('doctrine.orm.auto_generate_proxy_classes')) {
73		// See https://github.com/symfony/symfony/pull/3419 for usage of references
74		$container = &$this->container;
75
76		$proxyGenerator = function ($proxyDir, $proxyNamespace, $class) use (&$container) {
77		$originalClassName = ClassUtils::getRealClass($class);
78		/** @var $registry Registry */
79		$registry = $container->get('doctrine');
80
81		// Tries to auto-generate the proxy file
82		/** @var $em \Doctrine\ORM\EntityManager */
83		foreach ($registry->getManagers() as $em) {
84		if (!$em->getConfiguration()->getAutoGenerateProxyClasses()) {
		0 ignored issues – show Bug introduced 2015-11-24 12:12 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Doctrine\Common\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...
85		continue;
86		}
87
88		$metadataFactory = $em->getMetadataFactory();
89
90		if ($metadataFactory->isTransient($originalClassName)) {
91		continue;
92		}
93
94		$classMetadata = $metadataFactory->getMetadataFor($originalClassName);
95
96		$em->getProxyFactory()->generateProxyClasses(array($classMetadata));
		0 ignored issues – show Bug introduced 2015-11-24 12:12 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Doctrine\Common\Persistence\ObjectManager` as the method `getProxyFactory()` 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...
97
98		clearstatcache(true, Autoloader::resolveFile($proxyDir, $proxyNamespace, $class));
99
100		break;
101		}
102		};
103		}
104
105		$this->autoloader = Autoloader::register($dir, $namespace, $proxyGenerator);
106		}
107		}
108
109	View Code Duplication	private function clearManagerIfRequired($id)
		0 ignored issues – show Duplication introduced 2017-03-22 15:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
110		{
111		if ($this->container->getParameter($id . '.clear_on_shutdown') === true) {
112		if (!$this->container instanceof IntrospectableContainerInterface \|\| $this->container->initialized($id)) {
		0 ignored issues – show Bug introduced 2017-03-22 14:04 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Depend...tableContainerInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
113		$this->container->get($id)->clear();
114		}
115		}
116		}
117
118	View Code Duplication	private function closeConnectionIfRequired($id)
		0 ignored issues – show Duplication introduced 2017-03-22 15:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
119		{
120		if ($this->container->getParameter($id . '.close_on_shutdown') === true) {
121		if (!$this->container instanceof IntrospectableContainerInterface \|\| $this->container->initialized($id)) {
		0 ignored issues – show Bug introduced 2015-12-03 15:02 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Depend...tableContainerInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
122		$this->container->get($id)->close();
123		}
124		}
125		}
126
127		/**
128		* {@inheritDoc}
129		*/
130		public function shutdown()
131		{
132		if (null !== $this->autoloader) {
133		spl_autoload_unregister($this->autoloader);
134		$this->autoloader = null;
135		}
136
137		// Clear all entity managers to clear references to entities for GC
138		if ($this->container->hasParameter('doctrine.entity_managers')) {
139		foreach ($this->container->getParameter('doctrine.entity_managers') as $id) {
140		$this->clearManagerIfRequired($id);
141		}
142		}
143
144		// Close all connections to avoid reaching too many connections in the process when booting again later (tests)
145		if ($this->container->hasParameter('doctrine.connections')) {
146		foreach ($this->container->getParameter('doctrine.connections') as $id) {
147		$this->closeConnectionIfRequired($id);
148		}
149		}
150		}
151
152		/**
153		* {@inheritDoc}
154		*/
155		public function registerCommands(Application $application)
156		{
157		// Use the default logic when the ORM is available.
158		// This avoids listing all ORM commands by hand.
159		if (class_exists('Doctrine\\ORM\\Version')) {
160		parent::registerCommands($application);
161
162		return;
163		}
164
165		// Register only the DBAL commands if the ORM is not available.
166		$application->add(new CreateDatabaseDoctrineCommand());
167		$application->add(new DropDatabaseDoctrineCommand());
168		$application->add(new RunSqlDoctrineCommand());
169		$application->add(new ImportDoctrineCommand());
170		}
171		}
172

doctrine / DoctrineBundle

Pull Request — master (#642)

DoctrineBundle::clearManagerIfRequired() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like