RelationalBuilder - Code Metrics - Inspection of "tests coverage" - juliangut/doctrine-manager-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d34e64...7e6b75 )

by Julián

created 2016-10-17 21:11 UTC

RelationalBuilder F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	551
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	35

Importance

Changes

Metric	Value
wmc	51
lcom	1
cbo	35
dl	0
loc	551
rs	2.5647
c	0
b	0
f	0

24 Methods

Rating	Name	Size	Complexity
A	getDefaultOptions()	11	1
A	getManager()	12	3
A	wipe()	11	1
B	buildManager()	27	4
A	setUpGeneralConfigurations()	19	3
A	setUpSpecificConfigurations()	19	3
A	getAnnotationMetadataDriver()	4	1
A	getXmlMetadataDriver()	6	2
A	getYamlMetadataDriver()	6	2
A	getRepositoryFactory()	17	3
A	getQueryCacheDriver()	20	4
A	setQueryCacheDriver()	4	1
A	getResultCacheDriver()	20	4
A	setResultCacheDriver()	4	1
A	getNamingStrategy()	14	3
A	getQuoteStrategy()	14	3
A	getSQLLogger()	12	3
A	getCustomStringFunctions()	12	1
A	getCustomNumericFunctions()	12	1
A	getCustomDateTimeFunctions()	12	1
A	getCustomTypes()	12	1
A	getCustomFilters()	12	1
A	getConsoleCommands()	52	3
A	getConsoleHelperSet()	9	1

How to fix Complexity

<?php

/*
 * doctrine-manager-builder (https://github.com/juliangut/doctrine-manager-builder).
 * Doctrine2 managers builder.
 *
 * @license BSD-3-Clause
 * @link https://github.com/juliangut/doctrine-manager-builder
 * @author Julián Gutiérrez <[email protected]>
 */

namespace Jgut\Doctrine\ManagerBuilder;

use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Cache\CacheProvider;
use Doctrine\DBAL\Logging\SQLLogger;
use Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper;
use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\Configuration;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Mapping\DefaultQuoteStrategy;
use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
use Doctrine\ORM\Mapping\Driver\XmlDriver;
use Doctrine\ORM\Mapping\Driver\YamlDriver;
use Doctrine\ORM\Mapping\NamingStrategy;
use Doctrine\ORM\Mapping\QuoteStrategy;
use Doctrine\ORM\Mapping\UnderscoreNamingStrategy;
use Doctrine\ORM\Repository\RepositoryFactory;
use Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper;
use Doctrine\ORM\Version;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\HelperSet;

/**
 * Doctrine RDBMS Entity Manager builder.
 */
class RelationalBuilder extends AbstractManagerBuilder
{
    /**
     * Entity Manager.
     *
     * @var EntityManager
     */
    protected $manager;

    /**
     * Query cache driver.
     *
     * @var CacheProvider
     */
    protected $queryCacheDriver;

    /**
     * Result cache driver.
     *
     * @var CacheProvider
     */
    protected $resultCacheDriver;

    /**
     * Naming strategy.
     *
     * @var NamingStrategy
     */
    protected $namingStrategy;

    /**
     * Quote strategy.
     *
     * @var QuoteStrategy
     */
    protected $quoteStrategy;

    /**
     * SQL logger.
     *
     * @var SQLLogger
     */
    protected $SQLLogger;

    /**
     * {@inheritdoc}
     */
    protected function getDefaultOptions()
    {
        return [
            'connection' => [], // Array or \Doctrine\DBAL\Connection
            'proxies_namespace' => 'DoctrineRDBMSORMProxy',
            'metadata_cache_namespace' => 'DoctrineRDBMSORMMetadataCache',
            'query_cache_namespace' => 'DoctrineRDBMSORMQueryCache',
            'result_cache_namespace' => 'DoctrineRDBMSORMResultCache',
            'default_repository_class' => EntityRepository::class,
        ];
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Doctrine\DBAL\DBALException
     * @throws \Doctrine\ORM\ORMException
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     * @throws \UnexpectedValueException
     *
     * @return EntityManager
     */
    public function getManager($force = false)
    {
        if ($force === true) {
            $this->wipe();
        }

        if (!$this->manager instanceof EntityManager) {
            $this->manager = $this->buildManager();
        }

        return $this->manager;
    }

    /**
     * {@inheritdoc}
     */
    protected function wipe()
    {
        parent::wipe();

        $this->manager = null;
        $this->queryCacheDriver = null;
        $this->resultCacheDriver = null;
        $this->namingStrategy = null;
        $this->quoteStrategy = null;
        $this->SQLLogger = null;
    }

    /**
     * Build new Doctrine entity manager.
     *
     * @throws \Doctrine\DBAL\DBALException
     * @throws \Doctrine\ORM\ORMException
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     * @throws \UnexpectedValueException
     *
     * @return EntityManager
     */
    protected function buildManager()
    {
        $config = new Configuration();

        $this->setUpGeneralConfigurations($config);
        $this->setUpSpecificConfigurations($config);

        $eventManager = $this->getEventManager();
        if ($this->getEventSubscribers() !== null) {
            /* @var array $eventSubscribers */
            $eventSubscribers = $this->getEventSubscribers();

            foreach ($eventSubscribers as $eventSubscriber) {
                $eventManager->addEventSubscriber($eventSubscriber);
            }
        }

        $entityManager = EntityManager::create($this->getOption('connection'), $config, $eventManager);

        $platform = $entityManager->getConnection()->getDatabasePlatform();
        foreach ($this->getCustomTypes() as $type => $class) {
            Type::addType($type, $class);
            $platform->registerDoctrineTypeMapping($type, $type);
        }

        return $entityManager;
    }

    /**
     * Set up general manager configurations.
     *
     * @param Configuration $config
     */
    protected function setUpGeneralConfigurations(Configuration $config)
    {
        $this->setupAnnotationMetadata();
        $config->setMetadataDriverImpl($this->getMetadataMappingDriver());

        $config->setProxyDir($this->getProxiesPath());
        $config->setProxyNamespace($this->getProxiesNamespace());
        $config->setAutoGenerateProxyClasses($this->getProxiesAutoGeneration());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        if ($this->getRepositoryFactory() !== null) {
            $config->setRepositoryFactory($this->getRepositoryFactory());
        }

        if ($this->getDefaultRepositoryClass() !== null) {
            $config->setDefaultRepositoryClassName($this->getDefaultRepositoryClass());
        }

        $config->setMetadataCacheImpl($this->getMetadataCacheDriver());
    }

    /**
     * Set up manager specific configurations.
     *
     * @param Configuration $config
     */
    protected function setUpSpecificConfigurations(Configuration $config)
    {
        $config->setQueryCacheImpl($this->getQueryCacheDriver());
        $config->setResultCacheImpl($this->getResultCacheDriver());

        $config->setNamingStrategy($this->getNamingStrategy());
        $config->setQuoteStrategy($this->getQuoteStrategy());

        $config->setSQLLogger($this->getSQLLogger());
        $config->setCustomStringFunctions($this->getCustomStringFunctions());
        $config->setCustomNumericFunctions($this->getCustomNumericFunctions());
        $config->setCustomDatetimeFunctions($this->getCustomDateTimeFunctions());

        if (count($this->getCustomFilters())) {
            foreach ($this->getCustomFilters() as $name => $filterClass) {
                $config->addFilter($name, $filterClass);
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function getAnnotationMetadataDriver(array $paths)
    {
        return new AnnotationDriver(new AnnotationReader, $paths);
    }

    /**
     * {@inheritdoc}
     */
    protected function getXmlMetadataDriver(array $paths, $extension = null)
    {
        $extension = $extension ?: XmlDriver::DEFAULT_FILE_EXTENSION;

        return new XmlDriver($paths, $extension);
    }

    /**
     * {@inheritdoc}
     */
    protected function getYamlMetadataDriver(array $paths, $extension = null)
    {
        $extension = $extension ?: YamlDriver::DEFAULT_FILE_EXTENSION;

        return new YamlDriver($paths, $extension);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \InvalidArgumentException
     *
     * @return RepositoryFactory|null
     */
    protected function getRepositoryFactory()
    {
        if (!array_key_exists('repository_factory', $this->options)) {
            return;
        }

        $repositoryFactory = $this->options['repository_factory'];

        if (!$repositoryFactory instanceof RepositoryFactory) {
            throw new \InvalidArgumentException(sprintf(
                'Invalid factory class "%s". It must be a Doctrine\ORM\Repository\RepositoryFactory.',
                get_class($repositoryFactory)
            ));
        }

        return $repositoryFactory;
    }

    /**
     * Retrieve query cache driver.
     *
     * @throws \InvalidArgumentException
     *
     * @return CacheProvider
     */
    public function getQueryCacheDriver()
    {
        if (!$this->queryCacheDriver instanceof CacheProvider) {
            $queryCacheDriver = $this->getOption('query_cache_driver');
            $cacheNamespace = (string) $this->getOption('query_cache_namespace');

            if (!$queryCacheDriver instanceof CacheProvider) {
                $queryCacheDriver = clone $this->getMetadataCacheDriver();
                $queryCacheDriver->setNamespace($cacheNamespace);
            }

            if ($queryCacheDriver->getNamespace() === '') {
                $queryCacheDriver->setNamespace($cacheNamespace);
            }

            $this->queryCacheDriver = $queryCacheDriver;
        }

        return $this->queryCacheDriver;
    }

    /**
     * Set query cache driver.
     *
     * @param CacheProvider $queryCacheDriver
     */
    public function setQueryCacheDriver(CacheProvider $queryCacheDriver)
    {
        $this->queryCacheDriver = $queryCacheDriver;
    }

    /**
     * Retrieve result cache driver.
     *
     * @throws \InvalidArgumentException
     *
     * @return CacheProvider
     */
    public function getResultCacheDriver()
    {
        if (!$this->resultCacheDriver instanceof CacheProvider) {
            $resultCacheDriver = $this->getOption('result_cache_driver');
            $cacheNamespace = (string) $this->getOption('result_cache_namespace');

            if (!$resultCacheDriver instanceof CacheProvider) {
                $resultCacheDriver = clone $this->getMetadataCacheDriver();
                $resultCacheDriver->setNamespace($cacheNamespace);
            }

            if ($resultCacheDriver->getNamespace() === '') {
                $resultCacheDriver->setNamespace($cacheNamespace);
            }

            $this->resultCacheDriver = $resultCacheDriver;
        }

        return $this->resultCacheDriver;
    }

    /**
     * Set result cache driver.
     *
     * @param CacheProvider $resultCacheDriver
     */
    public function setResultCacheDriver(CacheProvider $resultCacheDriver)
    {
        $this->resultCacheDriver = $resultCacheDriver;
    }

    /**
     * Retrieve naming strategy.
     *
     * @return NamingStrategy
     */
    protected function getNamingStrategy()
    {
        if (!$this->namingStrategy instanceof NamingStrategy) {
            $namingStrategy = $this->getOption('naming_strategy');

            if (!$namingStrategy instanceof NamingStrategy) {
                $namingStrategy = new UnderscoreNamingStrategy(CASE_LOWER);
            }

            $this->namingStrategy = $namingStrategy;
        }

        return $this->namingStrategy;
    }

    /**
     * Retrieve quote strategy.
     *
     * @throws \InvalidArgumentException
     *
     * @return QuoteStrategy
     */
    protected function getQuoteStrategy()
    {
        if (!$this->quoteStrategy instanceof QuoteStrategy) {
            $quoteStrategy = $this->getOption('quote_strategy');

            if (!$quoteStrategy instanceof QuoteStrategy) {
                $quoteStrategy = new DefaultQuoteStrategy;
            }

            $this->quoteStrategy = $quoteStrategy;
        }

        return $this->quoteStrategy;
    }

    /**
     * Retrieve SQL logger.
     *
     * @return SQLLogger|null
     */
    protected function getSQLLogger()
    {
        if (!$this->SQLLogger instanceof SQLLogger) {
            $sqlLogger = $this->getOption('sql_logger');

            if ($sqlLogger instanceof SQLLogger) {
                $this->SQLLogger = $sqlLogger;
            }
        }

        return $this->SQLLogger;
    }

    /**
     * Retrieve custom DQL string functions.
     *
     * @return array
     */
    protected function getCustomStringFunctions()
    {
        $functions = (array) $this->getOption('custom_string_functions');

        return array_filter(
            $functions,
            function ($name) {
                return is_string($name);
            },
            ARRAY_FILTER_USE_KEY
        );
    }

    /**
     * Retrieve custom DQL numeric functions.
     *
     * @return array
     */
    protected function getCustomNumericFunctions()
    {
        $functions = (array) $this->getOption('custom_numeric_functions');

        return array_filter(
            $functions,
            function ($name) {
                return is_string($name);
            },
            ARRAY_FILTER_USE_KEY
        );
    }

    /**
     * Retrieve custom DQL date time functions.
     *
     * @return array
     */
    protected function getCustomDateTimeFunctions()
    {
        $functions = (array) $this->getOption('custom_datetime_functions');

        return array_filter(
            $functions,
            function ($name) {
                return is_string($name);
            },
            ARRAY_FILTER_USE_KEY
        );
    }

    /**
     * Retrieve custom DBAL types.
     *
     * @return array
     */
    protected function getCustomTypes()
    {
        $types = (array) $this->getOption('custom_types');

        return array_filter(
            $types,
            function ($name) {
                return is_string($name);
            },
            ARRAY_FILTER_USE_KEY
        );
    }

    /**
     * Get custom registered filters.
     *
     * @return array
     */
    protected function getCustomFilters()
    {
        $filters = (array) $this->getOption('custom_filters');

        return array_filter(
            $filters,
            function ($name) {
                return is_string($name);
            },
            ARRAY_FILTER_USE_KEY
        );
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Doctrine\DBAL\DBALException
     * @throws \Doctrine\ORM\ORMException
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     * @throws \Symfony\Component\Console\Exception\InvalidArgumentException
     * @throws \Symfony\Component\Console\Exception\LogicException
     * @throws \UnexpectedValueException
     *
     * @return Command[]
     */
    public function getConsoleCommands()
    {
        $commands = [
            // DBAL
            new \Doctrine\DBAL\Tools\Console\Command\RunSqlCommand(),
            new \Doctrine\DBAL\Tools\Console\Command\ImportCommand(),

            // ORM
            new \Doctrine\ORM\Tools\Console\Command\ClearCache\MetadataCommand(),
            new \Doctrine\ORM\Tools\Console\Command\ClearCache\ResultCommand(),
            new \Doctrine\ORM\Tools\Console\Command\ClearCache\QueryCommand(),
            new \Doctrine\ORM\Tools\Console\Command\SchemaTool\CreateCommand(),
            new \Doctrine\ORM\Tools\Console\Command\SchemaTool\UpdateCommand(),
            new \Doctrine\ORM\Tools\Console\Command\SchemaTool\DropCommand(),
            new \Doctrine\ORM\Tools\Console\Command\EnsureProductionSettingsCommand(),
            new \Doctrine\ORM\Tools\Console\Command\ConvertDoctrine1SchemaCommand(),
            new \Doctrine\ORM\Tools\Console\Command\GenerateRepositoriesCommand(),
            new \Doctrine\ORM\Tools\Console\Command\GenerateEntitiesCommand(),
            new \Doctrine\ORM\Tools\Console\Command\GenerateProxiesCommand(),
            new \Doctrine\ORM\Tools\Console\Command\ConvertMappingCommand(),
            new \Doctrine\ORM\Tools\Console\Command\RunDqlCommand(),
            new \Doctrine\ORM\Tools\Console\Command\ValidateSchemaCommand(),
            new \Doctrine\ORM\Tools\Console\Command\InfoCommand(),
        ];

        if (Version::compare('2.5') <= 0) {
            $commands[] = new \Doctrine\ORM\Tools\Console\Command\MappingDescribeCommand();
        }

        $commandPrefix = (string) $this->getName();

        if ($commandPrefix !== '') {
            $commands = array_map(
                function (Command $command) use ($commandPrefix) {
                    $commandNames = array_map(
                        function ($commandName) use ($commandPrefix) {
                            return preg_replace('/^(dbal|orm):/', $commandPrefix . ':$1:', $commandName);
                        },
                        array_merge([$command->getName()], $command->getAliases())
                    );

                    $command->setName(array_shift($commandNames));
                    $command->setAliases($commandNames);

                    return $command;
                },
                $commands
            );
        }

        return $commands;
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Doctrine\DBAL\DBALException
     * @throws \Doctrine\ORM\ORMException
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     * @throws \UnexpectedValueException
     */
    public function getConsoleHelperSet()
    {
        $entityManager = $this->getManager();

        return new HelperSet([
            'db' => new ConnectionHelper($entityManager->getConnection()),
            'em' => new EntityManagerHelper($entityManager),
        ]);
    }
}


1			<?php
2
3			/*
4			* doctrine-manager-builder (https://github.com/juliangut/doctrine-manager-builder).
5			* Doctrine2 managers builder.
6			*
7			* @license BSD-3-Clause
8			* @link https://github.com/juliangut/doctrine-manager-builder
9			* @author Julián Gutiérrez <[email protected]>
10			*/
11
12			namespace Jgut\Doctrine\ManagerBuilder;
13
14			use Doctrine\Common\Annotations\AnnotationReader;
15			use Doctrine\Common\Cache\CacheProvider;
16			use Doctrine\DBAL\Logging\SQLLogger;
17			use Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper;
18			use Doctrine\DBAL\Types\Type;
19			use Doctrine\ORM\Configuration;
20			use Doctrine\ORM\EntityManager;
21			use Doctrine\ORM\EntityRepository;
22			use Doctrine\ORM\Mapping\DefaultQuoteStrategy;
23			use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
24			use Doctrine\ORM\Mapping\Driver\XmlDriver;
25			use Doctrine\ORM\Mapping\Driver\YamlDriver;
26			use Doctrine\ORM\Mapping\NamingStrategy;
27			use Doctrine\ORM\Mapping\QuoteStrategy;
28			use Doctrine\ORM\Mapping\UnderscoreNamingStrategy;
29			use Doctrine\ORM\Repository\RepositoryFactory;
30			use Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper;
31			use Doctrine\ORM\Version;
32			use Symfony\Component\Console\Command\Command;
33			use Symfony\Component\Console\Helper\HelperSet;
34
35			/**
36			* Doctrine RDBMS Entity Manager builder.
37			*/
38			class RelationalBuilder extends AbstractManagerBuilder
39			{
40			/**
41			* Entity Manager.
42			*
43			* @var EntityManager
44			*/
45			protected $manager;
46
47			/**
48			* Query cache driver.
49			*
50			* @var CacheProvider
51			*/
52			protected $queryCacheDriver;
53
54			/**
55			* Result cache driver.
56			*
57			* @var CacheProvider
58			*/
59			protected $resultCacheDriver;
60
61			/**
62			* Naming strategy.
63			*
64			* @var NamingStrategy
65			*/
66			protected $namingStrategy;
67
68			/**
69			* Quote strategy.
70			*
71			* @var QuoteStrategy
72			*/
73			protected $quoteStrategy;
74
75			/**
76			* SQL logger.
77			*
78			* @var SQLLogger
79			*/
80			protected $SQLLogger;
81
82			/**
83			* {@inheritdoc}
84			*/
85			protected function getDefaultOptions()
86			{
87			return [
88			'connection' => [], // Array or \Doctrine\DBAL\Connection
89			'proxies_namespace' => 'DoctrineRDBMSORMProxy',
90			'metadata_cache_namespace' => 'DoctrineRDBMSORMMetadataCache',
91			'query_cache_namespace' => 'DoctrineRDBMSORMQueryCache',
92			'result_cache_namespace' => 'DoctrineRDBMSORMResultCache',
93			'default_repository_class' => EntityRepository::class,
94			];
95			}
96
97			/**
98			* {@inheritdoc}
99			*
100			* @throws \Doctrine\DBAL\DBALException
101			* @throws \Doctrine\ORM\ORMException
102			* @throws \InvalidArgumentException
103			* @throws \RuntimeException
104			* @throws \UnexpectedValueException
105			*
106			* @return EntityManager
107			*/
108			public function getManager($force = false)
109			{
110			if ($force === true) {
111			$this->wipe();
112			}
113
114			if (!$this->manager instanceof EntityManager) {
115			$this->manager = $this->buildManager();
116			}
117
118			return $this->manager;
119			}
120
121			/**
122			* {@inheritdoc}
123			*/
124			protected function wipe()
125			{
126			parent::wipe();
127
128			$this->manager = null;
129			$this->queryCacheDriver = null;
130			$this->resultCacheDriver = null;
131			$this->namingStrategy = null;
132			$this->quoteStrategy = null;
133			$this->SQLLogger = null;
134			}
135
136			/**
137			* Build new Doctrine entity manager.
138			*
139			* @throws \Doctrine\DBAL\DBALException
140			* @throws \Doctrine\ORM\ORMException
141			* @throws \InvalidArgumentException
142			* @throws \RuntimeException
143			* @throws \UnexpectedValueException
144			*
145			* @return EntityManager
146			*/
147			protected function buildManager()
148			{
149			$config = new Configuration();
150
151			$this->setUpGeneralConfigurations($config);
152			$this->setUpSpecificConfigurations($config);
153
154			$eventManager = $this->getEventManager();
155			if ($this->getEventSubscribers() !== null) {
156			/* @var array $eventSubscribers */
157			$eventSubscribers = $this->getEventSubscribers();
158
159			foreach ($eventSubscribers as $eventSubscriber) {
160			$eventManager->addEventSubscriber($eventSubscriber);
161			}
162			}
163
164			$entityManager = EntityManager::create($this->getOption('connection'), $config, $eventManager);
165
166			$platform = $entityManager->getConnection()->getDatabasePlatform();
167			foreach ($this->getCustomTypes() as $type => $class) {
168			Type::addType($type, $class);
169			$platform->registerDoctrineTypeMapping($type, $type);
170			}
171
172			return $entityManager;
173			}
174
175			/**
176			* Set up general manager configurations.
177			*
178			* @param Configuration $config
179			*/
180			protected function setUpGeneralConfigurations(Configuration $config)
181			{
182			$this->setupAnnotationMetadata();
183			$config->setMetadataDriverImpl($this->getMetadataMappingDriver());
184
185			$config->setProxyDir($this->getProxiesPath());
186			$config->setProxyNamespace($this->getProxiesNamespace());
187			$config->setAutoGenerateProxyClasses($this->getProxiesAutoGeneration());
			0 ignored issues – show Documentation introduced 2016-09-17 17:55 UTC by Report Bug Copy Issue Report `$this->getProxiesAutoGeneration()` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
188
189			if ($this->getRepositoryFactory() !== null) {
190			$config->setRepositoryFactory($this->getRepositoryFactory());
191			}
192
193			if ($this->getDefaultRepositoryClass() !== null) {
194			$config->setDefaultRepositoryClassName($this->getDefaultRepositoryClass());
195			}
196
197			$config->setMetadataCacheImpl($this->getMetadataCacheDriver());
198			}
199
200			/**
201			* Set up manager specific configurations.
202			*
203			* @param Configuration $config
204			*/
205			protected function setUpSpecificConfigurations(Configuration $config)
206			{
207			$config->setQueryCacheImpl($this->getQueryCacheDriver());
208			$config->setResultCacheImpl($this->getResultCacheDriver());
209
210			$config->setNamingStrategy($this->getNamingStrategy());
211			$config->setQuoteStrategy($this->getQuoteStrategy());
212
213			$config->setSQLLogger($this->getSQLLogger());
214			$config->setCustomStringFunctions($this->getCustomStringFunctions());
215			$config->setCustomNumericFunctions($this->getCustomNumericFunctions());
216			$config->setCustomDatetimeFunctions($this->getCustomDateTimeFunctions());
217
218			if (count($this->getCustomFilters())) {
219			foreach ($this->getCustomFilters() as $name => $filterClass) {
220			$config->addFilter($name, $filterClass);
221			}
222			}
223			}
224
225			/**
226			* {@inheritdoc}
227			*/
228			protected function getAnnotationMetadataDriver(array $paths)
229			{
230			return new AnnotationDriver(new AnnotationReader, $paths);
231			}
232
233			/**
234			* {@inheritdoc}
235			*/
236			protected function getXmlMetadataDriver(array $paths, $extension = null)
237			{
238			$extension = $extension ?: XmlDriver::DEFAULT_FILE_EXTENSION;
239
240			return new XmlDriver($paths, $extension);
241			}
242
243			/**
244			* {@inheritdoc}
245			*/
246			protected function getYamlMetadataDriver(array $paths, $extension = null)
247			{
248			$extension = $extension ?: YamlDriver::DEFAULT_FILE_EXTENSION;
249
250			return new YamlDriver($paths, $extension);
251			}
252
253			/**
254			* {@inheritdoc}
255			*
256			* @throws \InvalidArgumentException
257			*
258			* @return RepositoryFactory\|null
259			*/
260			protected function getRepositoryFactory()
261			{
262			if (!array_key_exists('repository_factory', $this->options)) {
263			return;
264			}
265
266			$repositoryFactory = $this->options['repository_factory'];
267
268			if (!$repositoryFactory instanceof RepositoryFactory) {
269			throw new \InvalidArgumentException(sprintf(
270			'Invalid factory class "%s". It must be a Doctrine\ORM\Repository\RepositoryFactory.',
271			get_class($repositoryFactory)
272			));
273			}
274
275			return $repositoryFactory;
276			}
277
278			/**
279			* Retrieve query cache driver.
280			*
281			* @throws \InvalidArgumentException
282			*
283			* @return CacheProvider
284			*/
285			public function getQueryCacheDriver()
286			{
287			if (!$this->queryCacheDriver instanceof CacheProvider) {
288			$queryCacheDriver = $this->getOption('query_cache_driver');
289			$cacheNamespace = (string) $this->getOption('query_cache_namespace');
290
291			if (!$queryCacheDriver instanceof CacheProvider) {
292			$queryCacheDriver = clone $this->getMetadataCacheDriver();
293			$queryCacheDriver->setNamespace($cacheNamespace);
294			}
295
296			if ($queryCacheDriver->getNamespace() === '') {
297			$queryCacheDriver->setNamespace($cacheNamespace);
298			}
299
300			$this->queryCacheDriver = $queryCacheDriver;
301			}
302
303			return $this->queryCacheDriver;
304			}
305
306			/**
307			* Set query cache driver.
308			*
309			* @param CacheProvider $queryCacheDriver
310			*/
311			public function setQueryCacheDriver(CacheProvider $queryCacheDriver)
312			{
313			$this->queryCacheDriver = $queryCacheDriver;
314			}
315
316			/**
317			* Retrieve result cache driver.
318			*
319			* @throws \InvalidArgumentException
320			*
321			* @return CacheProvider
322			*/
323			public function getResultCacheDriver()
324			{
325			if (!$this->resultCacheDriver instanceof CacheProvider) {
326			$resultCacheDriver = $this->getOption('result_cache_driver');
327			$cacheNamespace = (string) $this->getOption('result_cache_namespace');
328
329			if (!$resultCacheDriver instanceof CacheProvider) {
330			$resultCacheDriver = clone $this->getMetadataCacheDriver();
331			$resultCacheDriver->setNamespace($cacheNamespace);
332			}
333
334			if ($resultCacheDriver->getNamespace() === '') {
335			$resultCacheDriver->setNamespace($cacheNamespace);
336			}
337
338			$this->resultCacheDriver = $resultCacheDriver;
339			}
340
341			return $this->resultCacheDriver;
342			}
343
344			/**
345			* Set result cache driver.
346			*
347			* @param CacheProvider $resultCacheDriver
348			*/
349			public function setResultCacheDriver(CacheProvider $resultCacheDriver)
350			{
351			$this->resultCacheDriver = $resultCacheDriver;
352			}
353
354			/**
355			* Retrieve naming strategy.
356			*
357			* @return NamingStrategy
358			*/
359			protected function getNamingStrategy()
360			{
361			if (!$this->namingStrategy instanceof NamingStrategy) {
362			$namingStrategy = $this->getOption('naming_strategy');
363
364			if (!$namingStrategy instanceof NamingStrategy) {
365			$namingStrategy = new UnderscoreNamingStrategy(CASE_LOWER);
366			}
367
368			$this->namingStrategy = $namingStrategy;
369			}
370
371			return $this->namingStrategy;
372			}
373
374			/**
375			* Retrieve quote strategy.
376			*
377			* @throws \InvalidArgumentException
378			*
379			* @return QuoteStrategy
380			*/
381			protected function getQuoteStrategy()
382			{
383			if (!$this->quoteStrategy instanceof QuoteStrategy) {
384			$quoteStrategy = $this->getOption('quote_strategy');
385
386			if (!$quoteStrategy instanceof QuoteStrategy) {
387			$quoteStrategy = new DefaultQuoteStrategy;
388			}
389
390			$this->quoteStrategy = $quoteStrategy;
391			}
392
393			return $this->quoteStrategy;
394			}
395
396			/**
397			* Retrieve SQL logger.
398			*
399			* @return SQLLogger\|null
400			*/
401			protected function getSQLLogger()
402			{
403			if (!$this->SQLLogger instanceof SQLLogger) {
404			$sqlLogger = $this->getOption('sql_logger');
405
406			if ($sqlLogger instanceof SQLLogger) {
407			$this->SQLLogger = $sqlLogger;
408			}
409			}
410
411			return $this->SQLLogger;
412			}
413
414			/**
415			* Retrieve custom DQL string functions.
416			*
417			* @return array
418			*/
419			protected function getCustomStringFunctions()
420			{
421			$functions = (array) $this->getOption('custom_string_functions');
422
423			return array_filter(
424			$functions,
425			function ($name) {
426			return is_string($name);
427			},
428			ARRAY_FILTER_USE_KEY
429			);
430			}
431
432			/**
433			* Retrieve custom DQL numeric functions.
434			*
435			* @return array
436			*/
437			protected function getCustomNumericFunctions()
438			{
439			$functions = (array) $this->getOption('custom_numeric_functions');
440
441			return array_filter(
442			$functions,
443			function ($name) {
444			return is_string($name);
445			},
446			ARRAY_FILTER_USE_KEY
447			);
448			}
449
450			/**
451			* Retrieve custom DQL date time functions.
452			*
453			* @return array
454			*/
455			protected function getCustomDateTimeFunctions()
456			{
457			$functions = (array) $this->getOption('custom_datetime_functions');
458
459			return array_filter(
460			$functions,
461			function ($name) {
462			return is_string($name);
463			},
464			ARRAY_FILTER_USE_KEY
465			);
466			}
467
468			/**
469			* Retrieve custom DBAL types.
470			*
471			* @return array
472			*/
473			protected function getCustomTypes()
474			{
475			$types = (array) $this->getOption('custom_types');
476
477			return array_filter(
478			$types,
479			function ($name) {
480			return is_string($name);
481			},
482			ARRAY_FILTER_USE_KEY
483			);
484			}
485
486			/**
487			* Get custom registered filters.
488			*
489			* @return array
490			*/
491			protected function getCustomFilters()
492			{
493			$filters = (array) $this->getOption('custom_filters');
494
495			return array_filter(
496			$filters,
497			function ($name) {
498			return is_string($name);
499			},
500			ARRAY_FILTER_USE_KEY
501			);
502			}
503
504			/**
505			* {@inheritdoc}
506			*
507			* @throws \Doctrine\DBAL\DBALException
508			* @throws \Doctrine\ORM\ORMException
509			* @throws \InvalidArgumentException
510			* @throws \RuntimeException
511			* @throws \Symfony\Component\Console\Exception\InvalidArgumentException
512			* @throws \Symfony\Component\Console\Exception\LogicException
513			* @throws \UnexpectedValueException
514			*
515			* @return Command[]
516			*/
517			public function getConsoleCommands()
518			{
519			$commands = [
520			// DBAL
521			new \Doctrine\DBAL\Tools\Console\Command\RunSqlCommand(),
522			new \Doctrine\DBAL\Tools\Console\Command\ImportCommand(),
523
524			// ORM
525			new \Doctrine\ORM\Tools\Console\Command\ClearCache\MetadataCommand(),
526			new \Doctrine\ORM\Tools\Console\Command\ClearCache\ResultCommand(),
527			new \Doctrine\ORM\Tools\Console\Command\ClearCache\QueryCommand(),
528			new \Doctrine\ORM\Tools\Console\Command\SchemaTool\CreateCommand(),
529			new \Doctrine\ORM\Tools\Console\Command\SchemaTool\UpdateCommand(),
530			new \Doctrine\ORM\Tools\Console\Command\SchemaTool\DropCommand(),
531			new \Doctrine\ORM\Tools\Console\Command\EnsureProductionSettingsCommand(),
532			new \Doctrine\ORM\Tools\Console\Command\ConvertDoctrine1SchemaCommand(),
533			new \Doctrine\ORM\Tools\Console\Command\GenerateRepositoriesCommand(),
534			new \Doctrine\ORM\Tools\Console\Command\GenerateEntitiesCommand(),
535			new \Doctrine\ORM\Tools\Console\Command\GenerateProxiesCommand(),
536			new \Doctrine\ORM\Tools\Console\Command\ConvertMappingCommand(),
537			new \Doctrine\ORM\Tools\Console\Command\RunDqlCommand(),
538			new \Doctrine\ORM\Tools\Console\Command\ValidateSchemaCommand(),
539			new \Doctrine\ORM\Tools\Console\Command\InfoCommand(),
540			];
541
542			if (Version::compare('2.5') <= 0) {
543			$commands[] = new \Doctrine\ORM\Tools\Console\Command\MappingDescribeCommand();
544			}
545
546			$commandPrefix = (string) $this->getName();
547
548			if ($commandPrefix !== '') {
549			$commands = array_map(
550			function (Command $command) use ($commandPrefix) {
551			$commandNames = array_map(
552			function ($commandName) use ($commandPrefix) {
553			return preg_replace('/^(dbal\|orm):/', $commandPrefix . ':$1:', $commandName);
554			},
555			array_merge([$command->getName()], $command->getAliases())
556			);
557
558			$command->setName(array_shift($commandNames));
559			$command->setAliases($commandNames);
560
561			return $command;
562			},
563			$commands
564			);
565			}
566
567			return $commands;
568			}
569
570			/**
571			* {@inheritdoc}
572			*
573			* @throws \Doctrine\DBAL\DBALException
574			* @throws \Doctrine\ORM\ORMException
575			* @throws \InvalidArgumentException
576			* @throws \RuntimeException
577			* @throws \UnexpectedValueException
578			*/
579			public function getConsoleHelperSet()
580			{
581			$entityManager = $this->getManager();
582
583			return new HelperSet([
584			'db' => new ConnectionHelper($entityManager->getConnection()),
585			'em' => new EntityManagerHelper($entityManager),
586			]);
587			}
588			}
589

juliangut / doctrine-manager-builder

Push — master ( d34e64...7e6b75 )

RelationalBuilder F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

24 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like