AbstractClassMetadataFactory::getMetadataFor() - Code Metrics - Inspection of "Merge pull request #2 from doctrine/doctrine-codin..." - doctrine/persistence - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( ec2bd1...5afe97 )

by Jonathan

created 2018-06-08 21:10 UTC

AbstractClassMetadataFactory::getMetadataFor() C

↳ Parent: AbstractClassMetadataFactory

Complexity

Conditions	10
Paths	61

Size

Total Lines	57
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	27
CRAP Score	10.0328

Importance

Changes

Metric	Value
dl	0
loc	57
rs	6.7123
c	0
b	0
f	0
ccs	27
cts	29
cp	0.931
cc	10
eloc	32
nc	61
nop	1
crap	10.0328

How to fix Long Method Complexity

<?php

namespace Doctrine\Common\Persistence\Mapping;

use Doctrine\Common\Cache\Cache;
use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver;
use Doctrine\Common\Util\ClassUtils;
use ReflectionException;
use function array_reverse;
use function array_unshift;
use function explode;
use function strpos;

/**
 * The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
 * metadata mapping informations of a class which describes how a class should be mapped
 * to a relational database.
 *
 * This class was abstracted from the ORM ClassMetadataFactory.
 */
abstract class AbstractClassMetadataFactory implements ClassMetadataFactory
{
    /**
     * Salt used by specific Object Manager implementation.
     *
     * @var string
     */
    protected $cacheSalt = '$CLASSMETADATA';

    /** @var Cache|null */
    private $cacheDriver;

    /** @var ClassMetadata[] */
    private $loadedMetadata = [];

    /** @var bool */
    protected $initialized = false;

    /** @var ReflectionService|null */
    private $reflectionService = null;

    /**
     * Sets the cache driver used by the factory to cache ClassMetadata instances.
     *
     * @return void
     */
    public function setCacheDriver(?Cache $cacheDriver = null)
    {
        $this->cacheDriver = $cacheDriver;
    }

    /**
     * Gets the cache driver used by the factory to cache ClassMetadata instances.
     *
     * @return Cache|null
     */
    public function getCacheDriver()
    {
        return $this->cacheDriver;
    }

    /**
     * Returns an array of all the loaded metadata currently in memory.
     *
     * @return ClassMetadata[]
     */
    public function getLoadedMetadata()
    {
        return $this->loadedMetadata;
    }

    /**
     * Forces the factory to load the metadata of all classes known to the underlying
     * mapping driver.
     *
     * @return ClassMetadata[] The ClassMetadata instances of all mapped classes.
     */
    public function getAllMetadata()
    {
        if (! $this->initialized) {
            $this->initialize();
        }

        $driver   = $this->getDriver();
        $metadata = [];
        foreach ($driver->getAllClassNames() as $className) {
            $metadata[] = $this->getMetadataFor($className);
        }

        return $metadata;
    }

    /**
     * Lazy initialization of this stuff, especially the metadata driver,
     * since these are not needed at all when a metadata cache is active.
     *
     * @return void
     */
    abstract protected function initialize();

    /**
     * Gets the fully qualified class-name from the namespace alias.
     *
     * @param string $namespaceAlias
     * @param string $simpleClassName
     *
     * @return string
     */
    abstract protected function getFqcnFromAlias($namespaceAlias, $simpleClassName);

    /**
     * Returns the mapping driver implementation.
     *
     * @return MappingDriver
     */
    abstract protected function getDriver();

    /**
     * Wakes up reflection after ClassMetadata gets unserialized from cache.
     *
     * @return void
     */
    abstract protected function wakeupReflection(ClassMetadata $class, ReflectionService $reflService);

    /**
     * Initializes Reflection after ClassMetadata was constructed.
     *
     * @return void
     */
    abstract protected function initializeReflection(ClassMetadata $class, ReflectionService $reflService);

    /**
     * Checks whether the class metadata is an entity.
     *
     * This method should return false for mapped superclasses or embedded classes.
     *
     * @return bool
     */
    abstract protected function isEntity(ClassMetadata $class);

    /**
     * Gets the class metadata descriptor for a class.
     *
     * @param string $className The name of the class.
     *
     * @return ClassMetadata
     *
     * @throws ReflectionException
     * @throws MappingException
     */
    public function getMetadataFor($className)
    {
        if (isset($this->loadedMetadata[$className])) {
            return $this->loadedMetadata[$className];
        }

        // Check for namespace alias
        if (strpos($className, ':') !== false) {
            list($namespaceAlias, $simpleClassName) = explode(':', $className, 2);

            $realClassName = $this->getFqcnFromAlias($namespaceAlias, $simpleClassName);
        } else {
            $realClassName = ClassUtils::getRealClass($className);
        }

        if (isset($this->loadedMetadata[$realClassName])) {
            // We do not have the alias name in the map, include it
            return $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName];
        }

        $loadingException = null;


        try {
            if ($this->cacheDriver) {
                $cached = $this->cacheDriver->fetch($realClassName . $this->cacheSalt);
                if ($cached instanceof ClassMetadata) {
                    $this->loadedMetadata[$realClassName] = $cached;

                    $this->wakeupReflection($cached, $this->getReflectionService());
                } else {
                    foreach ($this->loadMetadata($realClassName) as $loadedClassName) {
                        $this->cacheDriver->save(
                            $loadedClassName . $this->cacheSalt,
                            $this->loadedMetadata[$loadedClassName],
                            null
                        );
                    }
                }
            } else {
                $this->loadMetadata($realClassName);
            }
        } catch (MappingException $loadingException) {
            $fallbackMetadataResponse = $this->onNotFoundMetadata($realClassName);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

            if (! $fallbackMetadataResponse) {

                throw $loadingException;
            }

            $this->loadedMetadata[$realClassName] = $fallbackMetadataResponse;
        }

        if ($className !== $realClassName) {
            // We do not have the alias name in the map, include it
            $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName];
        }

        return $this->loadedMetadata[$className];
    }

    /**
     * Checks whether the factory has the metadata for a class loaded already.
     *
     * @param string $className
     *
     * @return bool TRUE if the metadata of the class in question is already loaded, FALSE otherwise.
     */
    public function hasMetadataFor($className)
    {
        return isset($this->loadedMetadata[$className]);
    }

    /**
     * Sets the metadata descriptor for a specific class.
     *
     * NOTE: This is only useful in very special cases, like when generating proxy classes.
     *
     * @param string        $className
     * @param ClassMetadata $class
     *
     * @return void
     */
    public function setMetadataFor($className, $class)
    {
        $this->loadedMetadata[$className] = $class;
    }

    /**
     * Gets an array of parent classes for the given entity class.
     *
     * @param string $name
     *
     * @return string[]
     */
    protected function getParentClasses($name)
    {
        // Collect parent classes, ignoring transient (not-mapped) classes.
        $parentClasses = [];

        foreach (array_reverse($this->getReflectionService()->getParentClasses($name)) as $parentClass) {
            if ($this->getDriver()->isTransient($parentClass)) {
                continue;
            }

            $parentClasses[] = $parentClass;
        }

        return $parentClasses;
    }

    /**
     * Loads the metadata of the class in question and all it's ancestors whose metadata
     * is still not loaded.
     *
     * Important: The class $name does not necessarily exist at this point here.
     * Scenarios in a code-generation setup might have access to XML/YAML
     * Mapping files without the actual PHP code existing here. That is why the
     * {@see Doctrine\Common\Persistence\Mapping\ReflectionService} interface
     * should be used for reflection.
     *
     * @param string $name The name of the class for which the metadata should get loaded.
     *
     * @return string[]
     */
    protected function loadMetadata($name)
    {
        if (! $this->initialized) {
            $this->initialize();
        }

        $loaded = [];

        $parentClasses   = $this->getParentClasses($name);
        $parentClasses[] = $name;

        // Move down the hierarchy of parent classes, starting from the topmost class
        $parent          = null;
        $rootEntityFound = false;
        $visited         = [];
        $reflService     = $this->getReflectionService();
        foreach ($parentClasses as $className) {
            if (isset($this->loadedMetadata[$className])) {
                $parent = $this->loadedMetadata[$className];
                if ($this->isEntity($parent)) {
                    $rootEntityFound = true;
                    array_unshift($visited, $className);
                }
                continue;
            }

            $class = $this->newClassMetadataInstance($className);
            $this->initializeReflection($class, $reflService);

            $this->doLoadMetadata($class, $parent, $rootEntityFound, $visited);

            $this->loadedMetadata[$className] = $class;

            $parent = $class;

            if ($this->isEntity($class)) {
                $rootEntityFound = true;
                array_unshift($visited, $className);
            }

            $this->wakeupReflection($class, $reflService);

            $loaded[] = $className;
        }

        return $loaded;
    }

    /**
     * Provides a fallback hook for loading metadata when loading failed due to reflection/mapping exceptions
     *
     * Override this method to implement a fallback strategy for failed metadata loading
     *
     * @param string $className
     *
     * @return ClassMetadata|null
     */
    protected function onNotFoundMetadata($className)
    {
        return null;
    }

    /**
     * Actually loads the metadata from the underlying metadata.
     *
     * @param ClassMetadata      $class
     * @param ClassMetadata|null $parent
     * @param bool               $rootEntityFound
     * @param string[]           $nonSuperclassParents All parent class names
     *                                                 that are not marked as mapped superclasses.
     * @return void
     */
    abstract protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents);

    /**
     * Creates a new ClassMetadata instance for the given class name.
     *
     * @param string $className
     *
     * @return ClassMetadata
     */
    abstract protected function newClassMetadataInstance($className);

    /**
     * {@inheritDoc}
     */
    public function isTransient($class)
    {
        if (! $this->initialized) {
            $this->initialize();
        }

        // Check for namespace alias
        if (strpos($class, ':') !== false) {
            list($namespaceAlias, $simpleClassName) = explode(':', $class, 2);
            $class                                  = $this->getFqcnFromAlias($namespaceAlias, $simpleClassName);
        }

        return $this->getDriver()->isTransient($class);
    }

    /**
     * Sets the reflectionService.
     *
     * @return void
     */
    public function setReflectionService(ReflectionService $reflectionService)
    {
        $this->reflectionService = $reflectionService;
    }

    /**
     * Gets the reflection service associated with this metadata factory.
     *
     * @return ReflectionService
     */
    public function getReflectionService()
    {
        if ($this->reflectionService === null) {
            $this->reflectionService = new RuntimeReflectionService();
        }
        return $this->reflectionService;
    }
}


1		<?php
2
3		namespace Doctrine\Common\Persistence\Mapping;
4
5		use Doctrine\Common\Cache\Cache;
6		use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver;
7		use Doctrine\Common\Util\ClassUtils;
8		use ReflectionException;
9		use function array_reverse;
10		use function array_unshift;
11		use function explode;
12		use function strpos;
13
14		/**
15		* The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
16		* metadata mapping informations of a class which describes how a class should be mapped
17		* to a relational database.
18		*
19		* This class was abstracted from the ORM ClassMetadataFactory.
20		*/
21		abstract class AbstractClassMetadataFactory implements ClassMetadataFactory
22		{
23		/**
24		* Salt used by specific Object Manager implementation.
25		*
26		* @var string
27		*/
28		protected $cacheSalt = '$CLASSMETADATA';
29
30		/** @var Cache\|null */
31		private $cacheDriver;
32
33		/** @var ClassMetadata[] */
34		private $loadedMetadata = [];
35
36		/** @var bool */
37		protected $initialized = false;
38
39		/** @var ReflectionService\|null */
40		private $reflectionService = null;
41
42		/**
43		* Sets the cache driver used by the factory to cache ClassMetadata instances.
44		*
45		* @return void
46		*/
47	4	public function setCacheDriver(?Cache $cacheDriver = null)
48		{
49	4	$this->cacheDriver = $cacheDriver;
50	4	}
51
52		/**
53		* Gets the cache driver used by the factory to cache ClassMetadata instances.
54		*
55		* @return Cache\|null
56		*/
57	1	public function getCacheDriver()
58		{
59	1	return $this->cacheDriver;
60		}
61
62		/**
63		* Returns an array of all the loaded metadata currently in memory.
64		*
65		* @return ClassMetadata[]
66		*/
67		public function getLoadedMetadata()
68		{
69		return $this->loadedMetadata;
70		}
71
72		/**
73		* Forces the factory to load the metadata of all classes known to the underlying
74		* mapping driver.
75		*
76		* @return ClassMetadata[] The ClassMetadata instances of all mapped classes.
77		*/
78		public function getAllMetadata()
79		{
80		if (! $this->initialized) {
81		$this->initialize();
82		}
83
84		$driver = $this->getDriver();
85		$metadata = [];
86		foreach ($driver->getAllClassNames() as $className) {
87		$metadata[] = $this->getMetadataFor($className);
88		}
89
90		return $metadata;
91		}
92
93		/**
94		* Lazy initialization of this stuff, especially the metadata driver,
95		* since these are not needed at all when a metadata cache is active.
96		*
97		* @return void
98		*/
99		abstract protected function initialize();
100
101		/**
102		* Gets the fully qualified class-name from the namespace alias.
103		*
104		* @param string $namespaceAlias
105		* @param string $simpleClassName
106		*
107		* @return string
108		*/
109		abstract protected function getFqcnFromAlias($namespaceAlias, $simpleClassName);
110
111		/**
112		* Returns the mapping driver implementation.
113		*
114		* @return MappingDriver
115		*/
116		abstract protected function getDriver();
117
118		/**
119		* Wakes up reflection after ClassMetadata gets unserialized from cache.
120		*
121		* @return void
122		*/
123		abstract protected function wakeupReflection(ClassMetadata $class, ReflectionService $reflService);
124
125		/**
126		* Initializes Reflection after ClassMetadata was constructed.
127		*
128		* @return void
129		*/
130		abstract protected function initializeReflection(ClassMetadata $class, ReflectionService $reflService);
131
132		/**
133		* Checks whether the class metadata is an entity.
134		*
135		* This method should return false for mapped superclasses or embedded classes.
136		*
137		* @return bool
138		*/
139		abstract protected function isEntity(ClassMetadata $class);
140
141		/**
142		* Gets the class metadata descriptor for a class.
143		*
144		* @param string $className The name of the class.
145		*
146		* @return ClassMetadata
147		*
148		* @throws ReflectionException
149		* @throws MappingException
150		*/
151	10	public function getMetadataFor($className)
152		{
153	10	if (isset($this->loadedMetadata[$className])) {
154		return $this->loadedMetadata[$className];
155		}
156
157		// Check for namespace alias
158	10	if (strpos($className, ':') !== false) {
159	2	list($namespaceAlias, $simpleClassName) = explode(':', $className, 2);
160
161	2	$realClassName = $this->getFqcnFromAlias($namespaceAlias, $simpleClassName);
162		} else {
163	8	$realClassName = ClassUtils::getRealClass($className);
164		}
165
166	10	if (isset($this->loadedMetadata[$realClassName])) {
167		// We do not have the alias name in the map, include it
168		return $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName];
169		}
170
171	10	$loadingException = null;
		0 ignored issues – show Unused Code introduced 2018-06-06 16:47 UTC by Report Bug Copy Issue Report The assignment to `$loadingException` is dead and can be removed. Loading history...
172
173		try {
174	10	if ($this->cacheDriver) {
175	3	$cached = $this->cacheDriver->fetch($realClassName . $this->cacheSalt);
176	3	if ($cached instanceof ClassMetadata) {
177	1	$this->loadedMetadata[$realClassName] = $cached;
178
179	1	$this->wakeupReflection($cached, $this->getReflectionService());
180		} else {
181	2	foreach ($this->loadMetadata($realClassName) as $loadedClassName) {
182	1	$this->cacheDriver->save(
183	1	$loadedClassName . $this->cacheSalt,
184	1	$this->loadedMetadata[$loadedClassName],
185	2	null
186		);
187		}
188		}
189		} else {
190	9	$this->loadMetadata($realClassName);
191		}
192	5	} catch (MappingException $loadingException) {
193	5	$fallbackMetadataResponse = $this->onNotFoundMetadata($realClassName);
		0 ignored issues – show Bug introduced 2018-06-06 16:47 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$fallbackMetadataResponse` is correct as `$this->onNotFoundMetadata($realClassName)` targeting `Doctrine\Common\Persiste...y::onNotFoundMetadata()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
194
195	5	if (! $fallbackMetadataResponse) {
		0 ignored issues – show introduced 2018-06-08 20:13 UTC by Report Bug Copy Issue Report `$fallbackMetadataResponse` is of type `null`, thus it always evaluated to `false`. Loading history...
196	3	throw $loadingException;
197		}
198
199	2	$this->loadedMetadata[$realClassName] = $fallbackMetadataResponse;
200		}
201
202	7	if ($className !== $realClassName) {
203		// We do not have the alias name in the map, include it
204	1	$this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName];
205		}
206
207	7	return $this->loadedMetadata[$className];
208		}
209
210		/**
211		* Checks whether the factory has the metadata for a class loaded already.
212		*
213		* @param string $className
214		*
215		* @return bool TRUE if the metadata of the class in question is already loaded, FALSE otherwise.
216		*/
217	3	public function hasMetadataFor($className)
218		{
219	3	return isset($this->loadedMetadata[$className]);
220		}
221
222		/**
223		* Sets the metadata descriptor for a specific class.
224		*
225		* NOTE: This is only useful in very special cases, like when generating proxy classes.
226		*
227		* @param string $className
228		* @param ClassMetadata $class
229		*
230		* @return void
231		*/
232		public function setMetadataFor($className, $class)
233		{
234		$this->loadedMetadata[$className] = $class;
235		}
236
237		/**
238		* Gets an array of parent classes for the given entity class.
239		*
240		* @param string $name
241		*
242		* @return string[]
243		*/
244	9	protected function getParentClasses($name)
245		{
246		// Collect parent classes, ignoring transient (not-mapped) classes.
247	9	$parentClasses = [];
248
249	9	foreach (array_reverse($this->getReflectionService()->getParentClasses($name)) as $parentClass) {
250	3	if ($this->getDriver()->isTransient($parentClass)) {
251		continue;
252		}
253
254	3	$parentClasses[] = $parentClass;
255		}
256
257	4	return $parentClasses;
258		}
259
260		/**
261		* Loads the metadata of the class in question and all it's ancestors whose metadata
262		* is still not loaded.
263		*
264		* Important: The class $name does not necessarily exist at this point here.
265		* Scenarios in a code-generation setup might have access to XML/YAML
266		* Mapping files without the actual PHP code existing here. That is why the
267		* {@see Doctrine\Common\Persistence\Mapping\ReflectionService} interface
268		* should be used for reflection.
269		*
270		* @param string $name The name of the class for which the metadata should get loaded.
271		*
272		* @return string[]
273		*/
274	9	protected function loadMetadata($name)
275		{
276	9	if (! $this->initialized) {
277	9	$this->initialize();
278		}
279
280	9	$loaded = [];
281
282	9	$parentClasses = $this->getParentClasses($name);
283	4	$parentClasses[] = $name;
284
285		// Move down the hierarchy of parent classes, starting from the topmost class
286	4	$parent = null;
287	4	$rootEntityFound = false;
288	4	$visited = [];
289	4	$reflService = $this->getReflectionService();
290	4	foreach ($parentClasses as $className) {
291	4	if (isset($this->loadedMetadata[$className])) {
292		$parent = $this->loadedMetadata[$className];
293		if ($this->isEntity($parent)) {
294		$rootEntityFound = true;
295		array_unshift($visited, $className);
296		}
297		continue;
298		}
299
300	4	$class = $this->newClassMetadataInstance($className);
301	4	$this->initializeReflection($class, $reflService);
302
303	4	$this->doLoadMetadata($class, $parent, $rootEntityFound, $visited);
304
305	4	$this->loadedMetadata[$className] = $class;
306
307	4	$parent = $class;
308
309	4	if ($this->isEntity($class)) {
310	4	$rootEntityFound = true;
311	4	array_unshift($visited, $className);
312		}
313
314	4	$this->wakeupReflection($class, $reflService);
315
316	4	$loaded[] = $className;
317		}
318
319	4	return $loaded;
320		}
321
322		/**
323		* Provides a fallback hook for loading metadata when loading failed due to reflection/mapping exceptions
324		*
325		* Override this method to implement a fallback strategy for failed metadata loading
326		*
327		* @param string $className
328		*
329		* @return ClassMetadata\|null
330		*/
331		protected function onNotFoundMetadata($className)
332		{
333		return null;
334		}
335
336		/**
337		* Actually loads the metadata from the underlying metadata.
338		*
339		* @param ClassMetadata $class
340		* @param ClassMetadata\|null $parent
341		* @param bool $rootEntityFound
342		* @param string[] $nonSuperclassParents All parent class names
343		* that are not marked as mapped superclasses.
344		* @return void
345		*/
346		abstract protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents);
347
348		/**
349		* Creates a new ClassMetadata instance for the given class name.
350		*
351		* @param string $className
352		*
353		* @return ClassMetadata
354		*/
355		abstract protected function newClassMetadataInstance($className);
356
357		/**
358		* {@inheritDoc}
359		*/
360		public function isTransient($class)
361		{
362		if (! $this->initialized) {
363		$this->initialize();
364		}
365
366		// Check for namespace alias
367		if (strpos($class, ':') !== false) {
368		list($namespaceAlias, $simpleClassName) = explode(':', $class, 2);
369		$class = $this->getFqcnFromAlias($namespaceAlias, $simpleClassName);
370		}
371
372		return $this->getDriver()->isTransient($class);
373		}
374
375		/**
376		* Sets the reflectionService.
377		*
378		* @return void
379		*/
380		public function setReflectionService(ReflectionService $reflectionService)
381		{
382		$this->reflectionService = $reflectionService;
383		}
384
385		/**
386		* Gets the reflection service associated with this metadata factory.
387		*
388		* @return ReflectionService
389		*/
390	10	public function getReflectionService()
391		{
392	10	if ($this->reflectionService === null) {
393	10	$this->reflectionService = new RuntimeReflectionService();
394		}
395	10	return $this->reflectionService;
396		}
397		}
398

doctrine / persistence

Push — master ( ec2bd1...5afe97 )

AbstractClassMetadataFactory::getMetadataFor() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like