StaticPHPDriver::getAllClassNames() - Code Metrics - Inspection of "Namespace move BC compatibility layer" - doctrine/persistence - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.3.x (#71)

by Grégoire

created 2019-12-06 20:36 UTC

StaticPHPDriver::getAllClassNames() B

↳ Parent: StaticPHPDriver

Complexity

Conditions	10
Paths	15

Size

Total Lines	49
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	25
CRAP Score	10.1228

Importance

Changes

Metric	Value
eloc	27
dl	0
loc	49
rs	7.6666
c	0
b	0
f	0
ccs	25
cts	28
cp	0.8929
cc	10
nc	15
nop	0
crap	10.1228

How to fix Complexity

<?php

namespace Doctrine\Persistence\Mapping\Driver;

use Doctrine\Persistence\Mapping\ClassMetadata;
use Doctrine\Persistence\Mapping\MappingException;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use ReflectionClass;
use function array_merge;
use function array_unique;
use function get_declared_classes;
use function in_array;
use function is_dir;
use function method_exists;
use function realpath;
use Doctrine\Persistence\Mapping\Driver\MappingDriver;


/**
 * The StaticPHPDriver calls a static loadMetadata() method on your entity
 * classes where you can manually populate the ClassMetadata instance.
 */
class StaticPHPDriver implements MappingDriver
{
    /**
     * Paths of entity directories.
     *
     * @var string[]
     */
    private $paths = [];

    /**
     * Map of all class names.
     *
     * @var string[]
     */
    private $classNames;

    /**
     * @param string[]|string $paths
     */
    public function __construct($paths)
    {
        $this->addPaths((array) $paths);
    }

    /**
     * Adds paths.
     *
     * @param string[] $paths
     *
     * @return void
     */
    public function addPaths(array $paths)
    {
        $this->paths = array_unique(array_merge($this->paths, $paths));
    }

    /**
     * {@inheritdoc}
     */
    public function loadMetadataForClass($className, ClassMetadata $metadata)
    {
        $className::loadMetadata($metadata);
    }

    /**
     * {@inheritDoc}
     *
     * @todo Same code exists in AnnotationDriver, should we re-use it somehow or not worry about it?
     */
    public function getAllClassNames()
    {
        if ($this->classNames !== null) {
            return $this->classNames;
        }

        if (! $this->paths) {

            throw MappingException::pathRequired();
        }

        $classes       = [];
        $includedFiles = [];

        foreach ($this->paths as $path) {
            if (! is_dir($path)) {
                throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
            }

            $iterator = new RecursiveIteratorIterator(
                new RecursiveDirectoryIterator($path),
                RecursiveIteratorIterator::LEAVES_ONLY
            );

            foreach ($iterator as $file) {
                if ($file->getBasename('.php') === $file->getBasename()) {
                    continue;
                }

                $sourceFile = realpath($file->getPathName());
                require_once $sourceFile;
                $includedFiles[] = $sourceFile;
            }
        }

        $declared = get_declared_classes();

        foreach ($declared as $className) {
            $rc         = new ReflectionClass($className);
            $sourceFile = $rc->getFileName();
            if (! in_array($sourceFile, $includedFiles) || $this->isTransient($className)) {
                continue;
            }

            $classes[] = $className;
        }

        $this->classNames = $classes;

        return $classes;
    }

    /**
     * {@inheritdoc}
     */
    public function isTransient($className)
    {
        return ! method_exists($className, 'loadMetadata');
    }
}


1		<?php
2
3		namespace Doctrine\Persistence\Mapping\Driver;
4
5		use Doctrine\Persistence\Mapping\ClassMetadata;
6		use Doctrine\Persistence\Mapping\MappingException;
7		use RecursiveDirectoryIterator;
8		use RecursiveIteratorIterator;
9		use ReflectionClass;
10		use function array_merge;
11		use function array_unique;
12		use function get_declared_classes;
13		use function in_array;
14		use function is_dir;
15		use function method_exists;
16		use function realpath;
17		use Doctrine\Persistence\Mapping\Driver\MappingDriver;
		0 ignored issues – show Coding Style introduced 2019-12-06 18:25 UTC by Report Bug Copy Issue Report Use statements should be sorted alphabetically. The first wrong one is Doctrine\Persistence\Mapping\Driver\MappingDriver. Loading history... introduced 2019-12-06 18:25 UTC by Report Bug Copy Issue Report Use Doctrine\Persistence\Mapping\Driver\MappingDriver is from the same namespace – that is prohibited. Loading history...
18
19		/**
20		* The StaticPHPDriver calls a static loadMetadata() method on your entity
21		* classes where you can manually populate the ClassMetadata instance.
22		*/
23		class StaticPHPDriver implements MappingDriver
24		{
25		/**
26		* Paths of entity directories.
27		*
28		* @var string[]
29		*/
30		private $paths = [];
31
32		/**
33		* Map of all class names.
34		*
35		* @var string[]
36		*/
37		private $classNames;
38
39		/**
40		* @param string[]\|string $paths
41		*/
42	2	public function __construct($paths)
43		{
44	2	$this->addPaths((array) $paths);
45	2	}
46
47		/**
48		* Adds paths.
49		*
50		* @param string[] $paths
51		*
52		* @return void
53		*/
54	2	public function addPaths(array $paths)
55		{
56	2	$this->paths = array_unique(array_merge($this->paths, $paths));
57	2	}
58
59		/**
60		* {@inheritdoc}
61		*/
62	1	public function loadMetadataForClass($className, ClassMetadata $metadata)
63		{
64	1	$className::loadMetadata($metadata);
65	1	}
66
67		/**
68		* {@inheritDoc}
69		*
70		* @todo Same code exists in AnnotationDriver, should we re-use it somehow or not worry about it?
71		*/
72	1	public function getAllClassNames()
73		{
74	1	if ($this->classNames !== null) {
75		return $this->classNames;
76		}
77
78	1	if (! $this->paths) {
		0 ignored issues – show Bug Best Practice introduced 2018-06-08 19:29 UTC by Report Bug Copy Issue Report The expression `$this->paths` of type `string[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
79		throw MappingException::pathRequired();
80		}
81
82	1	$classes = [];
83	1	$includedFiles = [];
84
85	1	foreach ($this->paths as $path) {
86	1	if (! is_dir($path)) {
87		throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
88		}
89
90	1	$iterator = new RecursiveIteratorIterator(
91	1	new RecursiveDirectoryIterator($path),
92	1	RecursiveIteratorIterator::LEAVES_ONLY
93		);
94
95	1	foreach ($iterator as $file) {
96	1	if ($file->getBasename('.php') === $file->getBasename()) {
97	1	continue;
98		}
99
100	1	$sourceFile = realpath($file->getPathName());
101	1	require_once $sourceFile;
102	1	$includedFiles[] = $sourceFile;
103		}
104		}
105
106	1	$declared = get_declared_classes();
107
108	1	foreach ($declared as $className) {
109	1	$rc = new ReflectionClass($className);
110	1	$sourceFile = $rc->getFileName();
111	1	if (! in_array($sourceFile, $includedFiles) \|\| $this->isTransient($className)) {
112	1	continue;
113		}
114
115	1	$classes[] = $className;
116		}
117
118	1	$this->classNames = $classes;
119
120	1	return $classes;
121		}
122
123		/**
124		* {@inheritdoc}
125		*/
126	1	public function isTransient($className)
127		{
128	1	return ! method_exists($className, 'loadMetadata');
129		}
130		}
131

doctrine / persistence

Pull Request — 1.3.x (#71)

StaticPHPDriver::getAllClassNames() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like