Completed
Pull Request — master (#642)
by COLE
03:00
created

DoctrineBundle.php (4 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
/*
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'));
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()) {
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));
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
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
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
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
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