ConfigurationFactory::createService() - Code Metrics - Inspection of "Added ServiceManager v3 support" - doctrine/DoctrineORMModule - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#459)

by Vytautas

created 2016-06-28 07:17 UTC

ConfigurationFactory::createService() A

↳ Parent: ConfigurationFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	12
Bugs	2	Features	5

Metric	Value
c	12
b	2
f	5
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?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\Mapping\EntityListenerResolver;
use DoctrineORMModule\Service\DBALConfigurationFactory as DoctrineConfigurationFactory;
use Interop\Container\ContainerInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\ServiceManager\Exception\InvalidArgumentException;
use Doctrine\ORM\Configuration;

class ConfigurationFactory extends DoctrineConfigurationFactory
{
    /**
     * {@inheritDoc}
     *
     * @return Configuration
     */
    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
    {
        /** @var $options \DoctrineORMModule\Options\Configuration */
        $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 ($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;
    }

    public function createService(ServiceLocatorInterface $container)
    {
        return $this($container, Configuration::class);
    }

    protected function getOptionsClass()
    {
        return 'DoctrineORMModule\Options\Configuration';
    }
}


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\Mapping\EntityListenerResolver;
26		use DoctrineORMModule\Service\DBALConfigurationFactory as DoctrineConfigurationFactory;
27		use Interop\Container\ContainerInterface;
28		use Zend\ServiceManager\ServiceLocatorInterface;
29		use Zend\ServiceManager\Exception\InvalidArgumentException;
30		use Doctrine\ORM\Configuration;
31
32		class ConfigurationFactory extends DoctrineConfigurationFactory
33		{
34		/**
35		* {@inheritDoc}
36		*
37		* @return Configuration
38		*/
39	69	public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
40		{
41		/** @var $options \DoctrineORMModule\Options\Configuration */
42	69	$options = $this->getOptions($container);
43	69	$config = new Configuration();
44
45	69	$config->setAutoGenerateProxyClasses($options->getGenerateProxies());
46	69	$config->setProxyDir($options->getProxyDir());
47	69	$config->setProxyNamespace($options->getProxyNamespace());
48
49	69	$config->setEntityNamespaces($options->getEntityNamespaces());
50
51	69	$config->setCustomDatetimeFunctions($options->getDatetimeFunctions());
52	69	$config->setCustomStringFunctions($options->getStringFunctions());
53	69	$config->setCustomNumericFunctions($options->getNumericFunctions());
54
55	69	$config->setClassMetadataFactoryName($options->getClassMetadataFactoryName());
56
57	69	foreach ($options->getNamedQueries() as $name => $query) {
58		$config->addNamedQuery($name, $query);
59	69	}
60
61	69	foreach ($options->getNamedNativeQueries() as $name => $query) {
62		$config->addNamedNativeQuery($name, $query['sql'], new $query['rsm']);
63	69	}
64
65	69	foreach ($options->getCustomHydrationModes() as $modeName => $hydrator) {
66		$config->addCustomHydrationMode($modeName, $hydrator);
67	69	}
68
69	69	foreach ($options->getFilters() as $name => $class) {
70		$config->addFilter($name, $class);
71	69	}
72
73	69	$config->setMetadataCacheImpl($container->get($options->getMetadataCache()));
74	69	$config->setQueryCacheImpl($container->get($options->getQueryCache()));
75	69	$config->setResultCacheImpl($container->get($options->getResultCache()));
76	69	$config->setHydrationCacheImpl($container->get($options->getHydrationCache()));
77	69	$config->setMetadataDriverImpl($container->get($options->getDriver()));
78
79	69	if ($namingStrategy = $options->getNamingStrategy()) {
80	69	if (is_string($namingStrategy)) {
81	2	if (!$container->has($namingStrategy)) {
82	69	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	68	}
89	2	}
90
91	68	if ($repositoryFactory = $options->getRepositoryFactory()) {
92		if (is_string($repositoryFactory)) {
93		if (!$container->has($repositoryFactory)) {
94		throw new InvalidArgumentException(
95		sprintf('Repository factory "%s" not found', $repositoryFactory)
96		);
97		}
98
99		$config->setRepositoryFactory($container->get($repositoryFactory));
100		} else {
101		$config->setRepositoryFactory($repositoryFactory);
102		}
103		}
104
105	68	if ($entityListenerResolver = $options->getEntityListenerResolver()) {
106	2	if ($entityListenerResolver instanceof EntityListenerResolver) {
107	1	$config->setEntityListenerResolver($entityListenerResolver);
108	1	} else {
109	1	$config->setEntityListenerResolver($container->get($entityListenerResolver));
110		}
111	2	}
112
113	68	$secondLevelCache = $options->getSecondLevelCache();
114
115	68	if ($secondLevelCache->isEnabled()) {
116	1	$regionsConfig = new RegionsConfiguration(
117	1	$secondLevelCache->getDefaultLifetime(),
118	1	$secondLevelCache->getDefaultLockLifetime()
119	2	);
120
121	1	foreach ($secondLevelCache->getRegions() as $regionName => $regionConfig) {
122	1	if (isset($regionConfig['lifetime'])) {
123	1	$regionsConfig->setLifetime($regionName, $regionConfig['lifetime']);
124	1	}
125
126	1	if (isset($regionConfig['lock_lifetime'])) {
127	1	$regionsConfig->setLockLifetime($regionName, $regionConfig['lock_lifetime']);
128	1	}
129	1	}
130
131		// As Second Level Cache caches queries results, we reuse the result cache impl
132	1	$cacheFactory = new DefaultCacheFactory($regionsConfig, $config->getResultCacheImpl());
		0 ignored issues – show Bug introduced 2015-12-07 13:24 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...
133	1	$cacheFactory->setFileLockRegionDirectory($secondLevelCache->getFileLockRegionDirectory());
134
135	1	$cacheConfiguration = new CacheConfiguration();
136	1	$cacheConfiguration->setCacheFactory($cacheFactory);
137	1	$cacheConfiguration->setRegionsConfiguration($regionsConfig);
138
139	1	$config->setSecondLevelCacheEnabled();
140	1	$config->setSecondLevelCacheConfiguration($cacheConfiguration);
141	1	}
142
143	68	if ($className = $options->getDefaultRepositoryClassName()) {
144	57	$config->setDefaultRepositoryClassName($className);
145	57	}
146
147	68	$this->setupDBALConfiguration($container, $config);
148
149	68	return $config;
150		}
151
152	69	public function createService(ServiceLocatorInterface $container)
153		{
154	69	return $this($container, Configuration::class);
155		}
156
157	69	protected function getOptionsClass()
158		{
159	69	return 'DoctrineORMModule\Options\Configuration';
160		}
161		}
162

doctrine / DoctrineORMModule

Pull Request — master (#459)

ConfigurationFactory::createService() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like