ConfigurationFactory::__invoke() - Code Metrics - Inspection of "ZF3 support" - doctrine/DoctrineORMModule - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#479)

by Michał

created 2016-07-13 22:32 UTC

ConfigurationFactory::__invoke() F

↳ Parent: ConfigurationFactory

Complexity

Conditions	21
Paths	5392

Size

Total Lines	124
Code Lines	72

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	76
CRAP Score	22.1191

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
c	4
b	0
f	1
dl	0
loc	124
ccs	76
cts	88
cp	0.8636
rs	2
cc	21
eloc	72
nc	5392
nop	3
crap	22.1191

How to fix Long Method Complexity

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace DoctrineORMModule\Service;

use Doctrine\ORM\Cache\CacheConfiguration;
use Doctrine\ORM\Cache\DefaultCacheFactory;
use Doctrine\ORM\Cache\RegionsConfiguration;
use Doctrine\ORM\Configuration;
use Doctrine\ORM\Mapping\EntityListenerResolver;
use DoctrineORMModule\Options\Configuration as OptionsConfiguration;
use DoctrineORMModule\Service\DBALConfigurationFactory as DoctrineConfigurationFactory;
use Interop\Container\ContainerInterface;
use Zend\ServiceManager\Exception\InvalidArgumentException;

class ConfigurationFactory extends DoctrineConfigurationFactory
{
    /**
     * {@inheritDoc}
     *
     * @return Configuration
     */
    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
    {
        /** @var $options OptionsConfiguration */
        $options = $this->getOptions($container);
        $config  = new Configuration();

        $config->setAutoGenerateProxyClasses($options->getGenerateProxies());
        $config->setProxyDir($options->getProxyDir());
        $config->setProxyNamespace($options->getProxyNamespace());

        $config->setEntityNamespaces($options->getEntityNamespaces());

        $config->setCustomDatetimeFunctions($options->getDatetimeFunctions());
        $config->setCustomStringFunctions($options->getStringFunctions());
        $config->setCustomNumericFunctions($options->getNumericFunctions());

        $config->setClassMetadataFactoryName($options->getClassMetadataFactoryName());

        foreach ($options->getNamedQueries() as $name => $query) {
            $config->addNamedQuery($name, $query);
        }

        foreach ($options->getNamedNativeQueries() as $name => $query) {
            $config->addNamedNativeQuery($name, $query['sql'], new $query['rsm']);
        }

        foreach ($options->getCustomHydrationModes() as $modeName => $hydrator) {
            $config->addCustomHydrationMode($modeName, $hydrator);
        }

        foreach ($options->getFilters() as $name => $class) {
            $config->addFilter($name, $class);
        }

        $config->setMetadataCacheImpl($container->get($options->getMetadataCache()));
        $config->setQueryCacheImpl($container->get($options->getQueryCache()));
        $config->setResultCacheImpl($container->get($options->getResultCache()));
        $config->setHydrationCacheImpl($container->get($options->getHydrationCache()));
        $config->setMetadataDriverImpl($container->get($options->getDriver()));

        if ($namingStrategy = $options->getNamingStrategy()) {
            if (is_string($namingStrategy)) {
                if (! $container->has($namingStrategy)) {
                    throw new InvalidArgumentException(sprintf('Naming strategy "%s" not found', $namingStrategy));
                }

                $config->setNamingStrategy($container->get($namingStrategy));
            } else {
                $config->setNamingStrategy($namingStrategy);
            }
        }

        if ($quoteStrategy = $options->getQuoteStrategy()) {
            if (is_string($quoteStrategy)) {
                if (! $container->has($quoteStrategy)) {
                    throw new InvalidArgumentException(sprintf('Quote strategy "%s" not found', $quoteStrategy));
                }

                $config->setQuoteStrategy($container->get($quoteStrategy));
            } else {
                $config->setQuoteStrategy($quoteStrategy);
            }
        }

        if ($repositoryFactory = $options->getRepositoryFactory()) {
            if (is_string($repositoryFactory)) {
                if (! $container->has($repositoryFactory)) {
                    throw new InvalidArgumentException(
                        sprintf('Repository factory "%s" not found', $repositoryFactory)
                    );
                }

                $config->setRepositoryFactory($container->get($repositoryFactory));
            } else {
                $config->setRepositoryFactory($repositoryFactory);
            }
        }

        if ($entityListenerResolver = $options->getEntityListenerResolver()) {
            if ($entityListenerResolver instanceof EntityListenerResolver) {
                $config->setEntityListenerResolver($entityListenerResolver);
            } else {
                $config->setEntityListenerResolver($container->get($entityListenerResolver));
            }
        }

        $secondLevelCache = $options->getSecondLevelCache();

        if ($secondLevelCache->isEnabled()) {
            $regionsConfig = new RegionsConfiguration(
                $secondLevelCache->getDefaultLifetime(),
                $secondLevelCache->getDefaultLockLifetime()
            );

            foreach ($secondLevelCache->getRegions() as $regionName => $regionConfig) {
                if (isset($regionConfig['lifetime'])) {
                    $regionsConfig->setLifetime($regionName, $regionConfig['lifetime']);
                }

                if (isset($regionConfig['lock_lifetime'])) {
                    $regionsConfig->setLockLifetime($regionName, $regionConfig['lock_lifetime']);
                }
            }

            // As Second Level Cache caches queries results, we reuse the result cache impl
            $cacheFactory = new DefaultCacheFactory($regionsConfig, $config->getResultCacheImpl());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $cacheFactory->setFileLockRegionDirectory($secondLevelCache->getFileLockRegionDirectory());

            $cacheConfiguration = new CacheConfiguration();
            $cacheConfiguration->setCacheFactory($cacheFactory);
            $cacheConfiguration->setRegionsConfiguration($regionsConfig);

            $config->setSecondLevelCacheEnabled();
            $config->setSecondLevelCacheConfiguration($cacheConfiguration);
        }

        if ($className = $options->getDefaultRepositoryClassName()) {
            $config->setDefaultRepositoryClassName($className);
        }

        $this->setupDBALConfiguration($container, $config);

        return $config;
    }

    protected function getOptionsClass()
    {
        return OptionsConfiguration::class;
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace DoctrineORMModule\Service;
21
22		use Doctrine\ORM\Cache\CacheConfiguration;
23		use Doctrine\ORM\Cache\DefaultCacheFactory;
24		use Doctrine\ORM\Cache\RegionsConfiguration;
25		use Doctrine\ORM\Configuration;
26		use Doctrine\ORM\Mapping\EntityListenerResolver;
27		use DoctrineORMModule\Options\Configuration as OptionsConfiguration;
28		use DoctrineORMModule\Service\DBALConfigurationFactory as DoctrineConfigurationFactory;
29		use Interop\Container\ContainerInterface;
30		use Zend\ServiceManager\Exception\InvalidArgumentException;
31
32		class ConfigurationFactory extends DoctrineConfigurationFactory
33		{
34		/**
35		* {@inheritDoc}
36		*
37		* @return Configuration
38		*/
39	72	public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
40		{
41		/** @var $options OptionsConfiguration */
42	72	$options = $this->getOptions($container);
43	72	$config = new Configuration();
44
45	72	$config->setAutoGenerateProxyClasses($options->getGenerateProxies());
46	72	$config->setProxyDir($options->getProxyDir());
47	72	$config->setProxyNamespace($options->getProxyNamespace());
48
49	72	$config->setEntityNamespaces($options->getEntityNamespaces());
50
51	72	$config->setCustomDatetimeFunctions($options->getDatetimeFunctions());
52	72	$config->setCustomStringFunctions($options->getStringFunctions());
53	72	$config->setCustomNumericFunctions($options->getNumericFunctions());
54
55	72	$config->setClassMetadataFactoryName($options->getClassMetadataFactoryName());
56
57	72	foreach ($options->getNamedQueries() as $name => $query) {
58		$config->addNamedQuery($name, $query);
59	72	}
60
61	72	foreach ($options->getNamedNativeQueries() as $name => $query) {
62		$config->addNamedNativeQuery($name, $query['sql'], new $query['rsm']);
63	72	}
64
65	72	foreach ($options->getCustomHydrationModes() as $modeName => $hydrator) {
66		$config->addCustomHydrationMode($modeName, $hydrator);
67	72	}
68
69	72	foreach ($options->getFilters() as $name => $class) {
70	70	$config->addFilter($name, $class);
71	72	}
72
73	72	$config->setMetadataCacheImpl($container->get($options->getMetadataCache()));
74	72	$config->setQueryCacheImpl($container->get($options->getQueryCache()));
75	72	$config->setResultCacheImpl($container->get($options->getResultCache()));
76	72	$config->setHydrationCacheImpl($container->get($options->getHydrationCache()));
77	72	$config->setMetadataDriverImpl($container->get($options->getDriver()));
78
79	72	if ($namingStrategy = $options->getNamingStrategy()) {
80	3	if (is_string($namingStrategy)) {
81	2	if (! $container->has($namingStrategy)) {
82	1	throw new InvalidArgumentException(sprintf('Naming strategy "%s" not found', $namingStrategy));
83		}
84
85	1	$config->setNamingStrategy($container->get($namingStrategy));
86	1	} else {
87	1	$config->setNamingStrategy($namingStrategy);
88		}
89	2	}
90
91	71	if ($quoteStrategy = $options->getQuoteStrategy()) {
92	3	if (is_string($quoteStrategy)) {
93	2	if (! $container->has($quoteStrategy)) {
94	1	throw new InvalidArgumentException(sprintf('Quote strategy "%s" not found', $quoteStrategy));
95		}
96
97	1	$config->setQuoteStrategy($container->get($quoteStrategy));
98	1	} else {
99	1	$config->setQuoteStrategy($quoteStrategy);
100		}
101	2	}
102
103	70	if ($repositoryFactory = $options->getRepositoryFactory()) {
104		if (is_string($repositoryFactory)) {
105		if (! $container->has($repositoryFactory)) {
106		throw new InvalidArgumentException(
107		sprintf('Repository factory "%s" not found', $repositoryFactory)
108		);
109	1	}
110
111		$config->setRepositoryFactory($container->get($repositoryFactory));
112		} else {
113		$config->setRepositoryFactory($repositoryFactory);
114		}
115		}
116
117	70	if ($entityListenerResolver = $options->getEntityListenerResolver()) {
118	2	if ($entityListenerResolver instanceof EntityListenerResolver) {
119	1	$config->setEntityListenerResolver($entityListenerResolver);
120	1	} else {
121	1	$config->setEntityListenerResolver($container->get($entityListenerResolver));
122		}
123	2	}
124
125	70	$secondLevelCache = $options->getSecondLevelCache();
126
127	70	if ($secondLevelCache->isEnabled()) {
128	1	$regionsConfig = new RegionsConfiguration(
129	1	$secondLevelCache->getDefaultLifetime(),
130	1	$secondLevelCache->getDefaultLockLifetime()
131	1	);
132
133	1	foreach ($secondLevelCache->getRegions() as $regionName => $regionConfig) {
134	1	if (isset($regionConfig['lifetime'])) {
135	1	$regionsConfig->setLifetime($regionName, $regionConfig['lifetime']);
136	1	}
137
138	1	if (isset($regionConfig['lock_lifetime'])) {
139	1	$regionsConfig->setLockLifetime($regionName, $regionConfig['lock_lifetime']);
140	1	}
141	1	}
142
143		// As Second Level Cache caches queries results, we reuse the result cache impl
144	1	$cacheFactory = new DefaultCacheFactory($regionsConfig, $config->getResultCacheImpl());
		0 ignored issues – show Bug introduced 2016-01-31 20:55 UTC by Report Bug Copy Issue Report It seems like `$config->getResultCacheImpl()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
145	1	$cacheFactory->setFileLockRegionDirectory($secondLevelCache->getFileLockRegionDirectory());
146
147	1	$cacheConfiguration = new CacheConfiguration();
148	1	$cacheConfiguration->setCacheFactory($cacheFactory);
149	1	$cacheConfiguration->setRegionsConfiguration($regionsConfig);
150
151	1	$config->setSecondLevelCacheEnabled();
152	1	$config->setSecondLevelCacheConfiguration($cacheConfiguration);
153	1	}
154
155	70	if ($className = $options->getDefaultRepositoryClassName()) {
156	57	$config->setDefaultRepositoryClassName($className);
157	57	}
158
159	70	$this->setupDBALConfiguration($container, $config);
160
161	70	return $config;
162		}
163
164	72	protected function getOptionsClass()
165		{
166	72	return OptionsConfiguration::class;
167		}
168		}
169

doctrine / DoctrineORMModule

Pull Request — master (#479)

ConfigurationFactory::__invoke() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like