AbstractClassMetadataFactory::getAllMetadata() - Code Metrics - Inspection of "Remove support for entity namespaces (Foo:Bar)" - doctrine/orm - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#6935)

by Michael

created 2018-01-11 22:17 UTC

AbstractClassMetadataFactory::getAllMetadata() A

↳ Parent: AbstractClassMetadataFactory

Complexity

Conditions	3
Paths	4

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	4
nop	0
dl	0
loc	14
ccs	8
cts	8
cp	1
crap	3
rs	9.4285
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Doctrine\ORM\Mapping;

use Doctrine\Common\Cache\Cache;
use Doctrine\Common\Persistence\Mapping\ClassMetadataFactory;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Doctrine\Common\Persistence\Mapping\MappingException as CommonMappingException;
use Doctrine\ORM\Reflection\ReflectionService;
use Doctrine\ORM\Reflection\RuntimeReflectionService;
use Doctrine\ORM\Utility\StaticClassNameConverter;
use ReflectionException;

/**
 * The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
 * metadata mapping information 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 \Doctrine\Common\Cache\Cache|null
     */
    private $cacheDriver;

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

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

    /**
     * @var ReflectionService|null
     */
    protected $reflectionService;

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

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

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

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

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

        return $this->reflectionService;
    }

    /**
     * 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) : bool
    {
        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
     */
    public function setMetadataFor($className, $class) : void
    {
        $this->loadedMetadata[$className] = $class;
    }

    /**
     * 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.
     *
     * @throws \InvalidArgumentException
     * @throws \ReflectionException
     * @throws MappingException
     */
    public function getAllMetadata() : array
    {
        if (! $this->initialized) {
            $this->initialize();
        }

        $driver   = $this->getDriver();
        $metadata = [];

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

        return $metadata;

    }

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

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }

        $realClassName = $this->normalizeClassName($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];
        }

        $metadataBuildingContext = $this->newClassMetadataBuildingContext();
        $loadingException        = null;


        try {
            if ($this->cacheDriver) {
                $cached = $this->cacheDriver->fetch($realClassName . $this->cacheSalt);

                if ($cached instanceof ClassMetadata) {
                    $this->loadedMetadata[$realClassName] = $cached;

                    $cached->wakeupReflection($metadataBuildingContext->getReflectionService());
                } else {
                    foreach ($this->loadMetadata($realClassName, $metadataBuildingContext) as $loadedClass) {
                        $loadedClassName = $loadedClass->getClassName();

                        $this->cacheDriver->save($loadedClassName . $this->cacheSalt, $loadedClass, null);
                    }
                }
            } else {
                $this->loadMetadata($realClassName, $metadataBuildingContext);
            }
        } catch (CommonMappingException $loadingException) {
            $fallbackMetadataResponse = $this->onNotFoundMetadata($realClassName, $metadataBuildingContext);

            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];
        }

        $metadataBuildingContext->validate();

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

    /**
     * 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 ClassMetadata[]
     *
     * @throws \InvalidArgumentException
     */
    protected function loadMetadata(string $name, ClassMetadataBuildingContext $metadataBuildingContext) : array
    {
        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;

        foreach ($parentClasses as $className) {
            if (isset($this->loadedMetadata[$className])) {
                $parent = $this->loadedMetadata[$className];

                continue;
            }

            $class = $this->doLoadMetadata($className, $parent, $metadataBuildingContext);

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

            $parent = $class;

            $loaded[] = $class;
        }

        return $loaded;
    }

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

        return $this->getDriver()->isTransient($this->normalizeClassName($className));
    }

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

        foreach (array_reverse($this->getReflectionService()->getParentClasses($name)) as $parentClass) {
            if (! $this->getDriver()->isTransient($parentClass)) {
                $parentClasses[] = $parentClass;
            }
        }

        return $parentClasses;
    }

    /**
     * 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
     */
    protected function onNotFoundMetadata(
        string $className,
        ClassMetadataBuildingContext $metadataBuildingContext
    ) : ?ClassMetadata {
        return null;
    }

    private function normalizeClassName(string $className) : string
    {
        return StaticClassNameConverter::getRealClass($className);
    }

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

    /**
     * Returns the mapping driver implementation.
     */
    abstract protected function getDriver() : Driver\MappingDriver;

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

    /**
     * Creates a new ClassMetadata instance for the given class name.
     */
    abstract protected function doLoadMetadata(
        string $className,
        ?ClassMetadata $parent,
        ClassMetadataBuildingContext $metadataBuildingContext
    ) : ClassMetadata;

    /**
     * Creates a new ClassMetadataBuildingContext instance.
     */
    abstract protected function newClassMetadataBuildingContext() : ClassMetadataBuildingContext;
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\ORM\Mapping;
6
7		use Doctrine\Common\Cache\Cache;
8		use Doctrine\Common\Persistence\Mapping\ClassMetadataFactory;
		0 ignored issues – show Bug introduced 2017-12-10 07:24 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Doctrine\ORM\Mapping\ClassMetadataFactory`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
9		use Doctrine\Common\Persistence\Mapping\MappingException as CommonMappingException;
10		use Doctrine\ORM\Reflection\ReflectionService;
11		use Doctrine\ORM\Reflection\RuntimeReflectionService;
12		use Doctrine\ORM\Utility\StaticClassNameConverter;
13		use ReflectionException;
14
15		/**
16		* The ClassMetadataFactory is used to create ClassMetadata objects that contain all the
17		* metadata mapping information of a class which describes how a class should be mapped
18		* to a relational database.
19		*
20		* This class was abstracted from the ORM ClassMetadataFactory.
21		*/
22		abstract class AbstractClassMetadataFactory implements ClassMetadataFactory
23		{
24		/**
25		* Salt used by specific Object Manager implementation.
26		*
27		* @var string
28		*/
29		protected $cacheSalt = '$CLASSMETADATA';
30
31		/**
32		* @var \Doctrine\Common\Cache\Cache\|null
33		*/
34		private $cacheDriver;
35
36		/**
37		* @var ClassMetadata[]
38		*/
39		private $loadedMetadata = [];
40
41		/**
42		* @var bool
43		*/
44		protected $initialized = false;
45
46		/**
47		* @var ReflectionService\|null
48		*/
49		protected $reflectionService;
50
51		/**
52		* Sets the cache driver used by the factory to cache ClassMetadata instances.
53		*/
54	2259	public function setCacheDriver(?Cache $cacheDriver = null) : void
55		{
56	2259	$this->cacheDriver = $cacheDriver;
57	2259	}
58
59		/**
60		* Gets the cache driver used by the factory to cache ClassMetadata instances.
61		*/
62		public function getCacheDriver() : ?Cache
63		{
64		return $this->cacheDriver;
65		}
66
67		/**
68		* Returns an array of all the loaded metadata currently in memory.
69		*
70		* @return ClassMetadata[]
71		*/
72		public function getLoadedMetadata() : array
73		{
74		return $this->loadedMetadata;
75		}
76
77		/**
78		* Sets the reflectionService.
79		*/
80		public function setReflectionService(ReflectionService $reflectionService) : void
81		{
82		$this->reflectionService = $reflectionService;
83		}
84
85		/**
86		* Gets the reflection service associated with this metadata factory.
87		*/
88	1958	public function getReflectionService() : ReflectionService
89		{
90	1958	if ($this->reflectionService === null) {
91	1958	$this->reflectionService = new RuntimeReflectionService();
92		}
93
94	1958	return $this->reflectionService;
95		}
96
97		/**
98		* Checks whether the factory has the metadata for a class loaded already.
99		*
100		* @param string $className
101		*
102		* @return bool TRUE if the metadata of the class in question is already loaded, FALSE otherwise.
103		*/
104	81	public function hasMetadataFor($className) : bool
105		{
106	81	return isset($this->loadedMetadata[$className]);
107		}
108
109		/**
110		* Sets the metadata descriptor for a specific class.
111		*
112		* NOTE: This is only useful in very special cases, like when generating proxy classes.
113		*
114		* @param string $className
115		* @param ClassMetadata $class
116		*/
117	5	public function setMetadataFor($className, $class) : void
118		{
119	5	$this->loadedMetadata[$className] = $class;
120	5	}
121
122		/**
123		* Forces the factory to load the metadata of all classes known to the underlying
124		* mapping driver.
125		*
126		* @return ClassMetadata[] The ClassMetadata instances of all mapped classes.
127		*
128		* @throws \InvalidArgumentException
129		* @throws \ReflectionException
130		* @throws MappingException
131		*/
132	56	public function getAllMetadata() : array
133		{
134	56	if (! $this->initialized) {
135	56	$this->initialize();
136		}
137
138	56	$driver = $this->getDriver();
139	56	$metadata = [];
140
141	56	foreach ($driver->getAllClassNames() as $className) {
142	55	$metadata[] = $this->getMetadataFor($className);
143		}
144
145	56	return $metadata;
		0 ignored issues – show introduced 2017-12-10 07:24 UTC by Report Bug Copy Issue Report The expression `return $metadata` returns an array which contains values of type `Doctrine\ORM\Mapping\ClassMetadata` which are incompatible with the return type `Doctrine\Common\Persistence\Mapping\ClassMetadata` mandated by `Doctrine\Common\Persiste...ctory::getAllMetadata()`. Loading history...
146		}
147
148		/**
149		* Gets the class metadata descriptor for a class.
150		*
151		* @param string $className The name of the class.
152		*
153		* @throws \InvalidArgumentException
154		* @throws ReflectionException
155		* @throws CommonMappingException
156		*/
157	1963	public function getMetadataFor($className) : ClassMetadata
158		{
159	1963	if (isset($this->loadedMetadata[$className])) {
160	1636	return $this->loadedMetadata[$className];
		0 ignored issues – show Bug Best Practice introduced 2017-12-10 07:24 UTC by Report Bug Copy Issue Report The expression `return $this->loadedMetadata[$className]` returns the type `Doctrine\ORM\Mapping\ClassMetadata` which is incompatible with the return type mandated by `Doctrine\Common\Persiste...ctory::getMetadataFor()` of `Doctrine\Common\Persistence\Mapping\ClassMetadata`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
161		}
162
163	1958	$realClassName = $this->normalizeClassName($className);
164
165	1958	if (isset($this->loadedMetadata[$realClassName])) {
166		// We do not have the alias name in the map, include it
167	215	return $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName];
168		}
169
170	1958	$metadataBuildingContext = $this->newClassMetadataBuildingContext();
171	1958	$loadingException = null;
		0 ignored issues – show Unused Code introduced 2017-12-10 07:24 UTC by Report Bug Copy Issue Report The assignment to `$loadingException` is dead and can be removed. Loading history...
172
173		try {
174	1958	if ($this->cacheDriver) {
175	1851	$cached = $this->cacheDriver->fetch($realClassName . $this->cacheSalt);
176
177	1851	if ($cached instanceof ClassMetadata) {
178	1630	$this->loadedMetadata[$realClassName] = $cached;
179
180	1630	$cached->wakeupReflection($metadataBuildingContext->getReflectionService());
181		} else {
182	270	foreach ($this->loadMetadata($realClassName, $metadataBuildingContext) as $loadedClass) {
183	260	$loadedClassName = $loadedClass->getClassName();
184
185	1843	$this->cacheDriver->save($loadedClassName . $this->cacheSalt, $loadedClass, null);
186		}
187		}
188		} else {
189	1950	$this->loadMetadata($realClassName, $metadataBuildingContext);
190		}
191	22	} catch (CommonMappingException $loadingException) {
192	12	$fallbackMetadataResponse = $this->onNotFoundMetadata($realClassName, $metadataBuildingContext);
193
194	12	if (! $fallbackMetadataResponse) {
195	10	throw $loadingException;
196		}
197
198	2	$this->loadedMetadata[$realClassName] = $fallbackMetadataResponse;
199		}
200
201	1941	if ($className !== $realClassName) {
202		// We do not have the alias name in the map, include it
203	3	$this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName];
204		}
205
206	1941	$metadataBuildingContext->validate();
207
208	1941	return $this->loadedMetadata[$className];
209		}
210
211		/**
212		* Loads the metadata of the class in question and all it's ancestors whose metadata
213		* is still not loaded.
214		*
215		* Important: The class $name does not necessarily exist at this point here.
216		* Scenarios in a code-generation setup might have access to XML/YAML
217		* Mapping files without the actual PHP code existing here. That is why the
218		* {@see Doctrine\Common\Persistence\Mapping\ReflectionService} interface
219		* should be used for reflection.
220		*
221		* @param string $name The name of the class for which the metadata should
222		* get loaded.
223		*
224		* @return ClassMetadata[]
225		*
226		* @throws \InvalidArgumentException
227		*/
228	378	protected function loadMetadata(string $name, ClassMetadataBuildingContext $metadataBuildingContext) : array
229		{
230	378	if (! $this->initialized) {
231	373	$this->initialize();
232		}
233
234	378	$loaded = [];
235
236	378	$parentClasses = $this->getParentClasses($name);
237	367	$parentClasses[] = $name;
238
239		// Move down the hierarchy of parent classes, starting from the topmost class
240	367	$parent = null;
241
242	367	foreach ($parentClasses as $className) {
243	367	if (isset($this->loadedMetadata[$className])) {
244	73	$parent = $this->loadedMetadata[$className];
245
246	73	continue;
247		}
248
249	367	$class = $this->doLoadMetadata($className, $parent, $metadataBuildingContext);
250
251	361	$this->loadedMetadata[$className] = $class;
252
253	361	$parent = $class;
254
255	361	$loaded[] = $class;
256		}
257
258	358	return $loaded;
259		}
260
261		/**
262		* {@inheritDoc}
263		*/
264	47	public function isTransient($className) : bool
265		{
266	47	if (! $this->initialized) {
267	15	$this->initialize();
268		}
269
270	47	return $this->getDriver()->isTransient($this->normalizeClassName($className));
271		}
272
273		/**
274		* Gets an array of parent classes for the given entity class.
275		*
276		* @param string $name
277		*
278		* @return string[]
279		*
280		* @throws \InvalidArgumentException
281		*/
282	378	protected function getParentClasses($name) : array
283		{
284		// Collect parent classes, ignoring transient (not-mapped) classes.
285	378	$parentClasses = [];
286
287	378	foreach (array_reverse($this->getReflectionService()->getParentClasses($name)) as $parentClass) {
288	105	if (! $this->getDriver()->isTransient($parentClass)) {
289	105	$parentClasses[] = $parentClass;
290		}
291		}
292
293	367	return $parentClasses;
294		}
295
296		/**
297		* Provides a fallback hook for loading metadata when loading failed due to reflection/mapping exceptions
298		*
299		* Override this method to implement a fallback strategy for failed metadata loading
300		*/
301		protected function onNotFoundMetadata(
302		string $className,
303		ClassMetadataBuildingContext $metadataBuildingContext
304		) : ?ClassMetadata {
305		return null;
306		}
307
308	1959	private function normalizeClassName(string $className) : string
309		{
310	1959	return StaticClassNameConverter::getRealClass($className);
311		}
312
313		/**
314		* Lazy initialization of this stuff, especially the metadata driver,
315		* since these are not needed at all when a metadata cache is active.
316		*/
317		abstract protected function initialize() : void;
318
319		/**
320		* Returns the mapping driver implementation.
321		*/
322		abstract protected function getDriver() : Driver\MappingDriver;
323
324		/**
325		* Checks whether the class metadata is an entity.
326		*
327		* This method should return false for mapped superclasses or embedded classes.
328		*/
329		abstract protected function isEntity(ClassMetadata $class) : bool;
330
331		/**
332		* Creates a new ClassMetadata instance for the given class name.
333		*/
334		abstract protected function doLoadMetadata(
335		string $className,
336		?ClassMetadata $parent,
337		ClassMetadataBuildingContext $metadataBuildingContext
338		) : ClassMetadata;
339
340		/**
341		* Creates a new ClassMetadataBuildingContext instance.
342		*/
343		abstract protected function newClassMetadataBuildingContext() : ClassMetadataBuildingContext;
344		}
345

doctrine / orm

Pull Request — master (#6935)

AbstractClassMetadataFactory::getAllMetadata() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like