AnnotationDriver::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

AnnotationDriver::getAllClassNames() C

↳ Parent: AnnotationDriver

Complexity

Conditions	12
Paths	27

Size

Total Lines	64
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	29
CRAP Score	13.0579

Importance

Changes

Metric	Value
eloc	35
dl	0
loc	64
rs	6.9666
c	0
b	0
f	0
ccs	29
cts	36
cp	0.8056
cc	12
nc	27
nop	0
crap	13.0579

How to fix Long Method Complexity

<?php

namespace Doctrine\Persistence\Mapping\Driver;

use Doctrine\Common\Annotations\Reader;
use Doctrine\Persistence\Mapping\MappingException;
use FilesystemIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use RecursiveRegexIterator;
use ReflectionClass;
use RegexIterator;
use function array_merge;
use function array_unique;
use function get_class;
use function get_declared_classes;
use function in_array;
use function is_dir;
use function preg_match;
use function preg_quote;
use function realpath;
use function str_replace;
use function strpos;

/**
 * The AnnotationDriver reads the mapping metadata from docblock annotations.
 */
abstract class AnnotationDriver implements MappingDriver
{
    /**
     * The annotation reader.
     *
     * @var Reader
     */
    protected $reader;

    /**
     * The paths where to look for mapping files.
     *
     * @var string[]
     */
    protected $paths = [];

    /**
     * The paths excluded from path where to look for mapping files.
     *
     * @var string[]
     */
    protected $excludePaths = [];

    /**
     * The file extension of mapping documents.
     *
     * @var string
     */
    protected $fileExtension = '.php';

    /**
     * Cache for AnnotationDriver#getAllClassNames().
     *
     * @var string[]|null
     */
    protected $classNames;

    /**
     * Name of the entity annotations as keys.
     *
     * @var string[]
     */
    protected $entityAnnotationClasses = [];

    /**
     * Initializes a new AnnotationDriver that uses the given AnnotationReader for reading
     * docblock annotations.
     *
     * @param Reader               $reader The AnnotationReader to use, duck-typed.
     * @param string|string[]|null $paths  One or multiple paths where mapping classes can be found.
     */
    public function __construct($reader, $paths = null)
    {
        $this->reader = $reader;
        if (! $paths) {
            return;
        }

        $this->addPaths((array) $paths);
    }

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

    /**
     * Retrieves the defined metadata lookup paths.
     *
     * @return string[]
     */
    public function getPaths()
    {
        return $this->paths;
    }

    /**
     * Append exclude lookup paths to metadata driver.
     *
     * @param string[] $paths
     */
    public function addExcludePaths(array $paths)
    {
        $this->excludePaths = array_unique(array_merge($this->excludePaths, $paths));
    }

    /**
     * Retrieve the defined metadata lookup exclude paths.
     *
     * @return string[]
     */
    public function getExcludePaths()
    {
        return $this->excludePaths;
    }

    /**
     * Retrieve the current annotation reader
     *
     * @return Reader
     */
    public function getReader()
    {
        return $this->reader;
    }

    /**
     * Gets the file extension used to look for mapping files under.
     *
     * @return string
     */
    public function getFileExtension()
    {
        return $this->fileExtension;
    }

    /**
     * Sets the file extension used to look for mapping files under.
     *
     * @param string $fileExtension The file extension to set.
     *
     * @return void
     */
    public function setFileExtension($fileExtension)
    {
        $this->fileExtension = $fileExtension;
    }

    /**
     * Returns whether the class with the specified name is transient. Only non-transient
     * classes, that is entities and mapped superclasses, should have their metadata loaded.
     *
     * A class is non-transient if it is annotated with an annotation
     * from the {@see AnnotationDriver::entityAnnotationClasses}.
     *
     * @param string $className
     *
     * @return bool
     */
    public function isTransient($className)
    {
        $classAnnotations = $this->reader->getClassAnnotations(new ReflectionClass($className));

        foreach ($classAnnotations as $annot) {
            if (isset($this->entityAnnotationClasses[get_class($annot)])) {
                return false;
            }
        }
        return true;
    }

    /**
     * {@inheritDoc}
     */
    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 RegexIterator(
                new RecursiveIteratorIterator(
                    new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
                    RecursiveIteratorIterator::LEAVES_ONLY
                ),
                '/^.+' . preg_quote($this->fileExtension) . '$/i',
                RecursiveRegexIterator::GET_MATCH
            );

            foreach ($iterator as $file) {
                $sourceFile = $file[0];

                if (! preg_match('(^phar:)i', $sourceFile)) {
                    $sourceFile = realpath($sourceFile);
                }

                foreach ($this->excludePaths as $excludePath) {
                    $exclude = str_replace('\\', '/', realpath($excludePath));
                    $current = str_replace('\\', '/', $sourceFile);

                    if (strpos($current, $exclude) !== false) {
                        continue 2;
                    }
                }

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


1		<?php
2
3		namespace Doctrine\Persistence\Mapping\Driver;
4
5		use Doctrine\Common\Annotations\Reader;
6		use Doctrine\Persistence\Mapping\MappingException;
7		use FilesystemIterator;
8		use RecursiveDirectoryIterator;
9		use RecursiveIteratorIterator;
10		use RecursiveRegexIterator;
11		use ReflectionClass;
12		use RegexIterator;
13		use function array_merge;
14		use function array_unique;
15		use function get_class;
16		use function get_declared_classes;
17		use function in_array;
18		use function is_dir;
19		use function preg_match;
20		use function preg_quote;
21		use function realpath;
22		use function str_replace;
23		use function strpos;
24
25		/**
26		* The AnnotationDriver reads the mapping metadata from docblock annotations.
27		*/
28		abstract class AnnotationDriver implements MappingDriver
29		{
30		/**
31		* The annotation reader.
32		*
33		* @var Reader
34		*/
35		protected $reader;
36
37		/**
38		* The paths where to look for mapping files.
39		*
40		* @var string[]
41		*/
42		protected $paths = [];
43
44		/**
45		* The paths excluded from path where to look for mapping files.
46		*
47		* @var string[]
48		*/
49		protected $excludePaths = [];
50
51		/**
52		* The file extension of mapping documents.
53		*
54		* @var string
55		*/
56		protected $fileExtension = '.php';
57
58		/**
59		* Cache for AnnotationDriver#getAllClassNames().
60		*
61		* @var string[]\|null
62		*/
63		protected $classNames;
64
65		/**
66		* Name of the entity annotations as keys.
67		*
68		* @var string[]
69		*/
70		protected $entityAnnotationClasses = [];
71
72		/**
73		* Initializes a new AnnotationDriver that uses the given AnnotationReader for reading
74		* docblock annotations.
75		*
76		* @param Reader $reader The AnnotationReader to use, duck-typed.
77		* @param string\|string[]\|null $paths One or multiple paths where mapping classes can be found.
78		*/
79	1	public function __construct($reader, $paths = null)
80		{
81	1	$this->reader = $reader;
82	1	if (! $paths) {
83		return;
84		}
85
86	1	$this->addPaths((array) $paths);
87	1	}
88
89		/**
90		* Appends lookup paths to metadata driver.
91		*
92		* @param string[] $paths
93		*
94		* @return void
95		*/
96	1	public function addPaths(array $paths)
97		{
98	1	$this->paths = array_unique(array_merge($this->paths, $paths));
99	1	}
100
101		/**
102		* Retrieves the defined metadata lookup paths.
103		*
104		* @return string[]
105		*/
106		public function getPaths()
107		{
108		return $this->paths;
109		}
110
111		/**
112		* Append exclude lookup paths to metadata driver.
113		*
114		* @param string[] $paths
115		*/
116		public function addExcludePaths(array $paths)
117		{
118		$this->excludePaths = array_unique(array_merge($this->excludePaths, $paths));
119		}
120
121		/**
122		* Retrieve the defined metadata lookup exclude paths.
123		*
124		* @return string[]
125		*/
126		public function getExcludePaths()
127		{
128		return $this->excludePaths;
129		}
130
131		/**
132		* Retrieve the current annotation reader
133		*
134		* @return Reader
135		*/
136		public function getReader()
137		{
138		return $this->reader;
139		}
140
141		/**
142		* Gets the file extension used to look for mapping files under.
143		*
144		* @return string
145		*/
146		public function getFileExtension()
147		{
148		return $this->fileExtension;
149		}
150
151		/**
152		* Sets the file extension used to look for mapping files under.
153		*
154		* @param string $fileExtension The file extension to set.
155		*
156		* @return void
157		*/
158		public function setFileExtension($fileExtension)
159		{
160		$this->fileExtension = $fileExtension;
161		}
162
163		/**
164		* Returns whether the class with the specified name is transient. Only non-transient
165		* classes, that is entities and mapped superclasses, should have their metadata loaded.
166		*
167		* A class is non-transient if it is annotated with an annotation
168		* from the {@see AnnotationDriver::entityAnnotationClasses}.
169		*
170		* @param string $className
171		*
172		* @return bool
173		*/
174	1	public function isTransient($className)
175		{
176	1	$classAnnotations = $this->reader->getClassAnnotations(new ReflectionClass($className));
177
178	1	foreach ($classAnnotations as $annot) {
179	1	if (isset($this->entityAnnotationClasses[get_class($annot)])) {
180	1	return false;
181		}
182		}
183	1	return true;
184		}
185
186		/**
187		* {@inheritDoc}
188		*/
189	1	public function getAllClassNames()
190		{
191	1	if ($this->classNames !== null) {
192		return $this->classNames;
193		}
194
195	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...
196		throw MappingException::pathRequired();
197		}
198
199	1	$classes = [];
200	1	$includedFiles = [];
201
202	1	foreach ($this->paths as $path) {
203	1	if (! is_dir($path)) {
204		throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
205		}
206
207	1	$iterator = new RegexIterator(
208	1	new RecursiveIteratorIterator(
209	1	new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
210	1	RecursiveIteratorIterator::LEAVES_ONLY
211		),
212	1	'/^.+' . preg_quote($this->fileExtension) . '$/i',
213	1	RecursiveRegexIterator::GET_MATCH
214		);
215
216	1	foreach ($iterator as $file) {
217	1	$sourceFile = $file[0];
218
219	1	if (! preg_match('(^phar:)i', $sourceFile)) {
220	1	$sourceFile = realpath($sourceFile);
221		}
222
223	1	foreach ($this->excludePaths as $excludePath) {
224		$exclude = str_replace('\\', '/', realpath($excludePath));
225		$current = str_replace('\\', '/', $sourceFile);
226
227		if (strpos($current, $exclude) !== false) {
228		continue 2;
229		}
230		}
231
232	1	require_once $sourceFile;
233
234	1	$includedFiles[] = $sourceFile;
235		}
236		}
237
238	1	$declared = get_declared_classes();
239
240	1	foreach ($declared as $className) {
241	1	$rc = new ReflectionClass($className);
242	1	$sourceFile = $rc->getFileName();
243	1	if (! in_array($sourceFile, $includedFiles) \|\| $this->isTransient($className)) {
244	1	continue;
245		}
246
247	1	$classes[] = $className;
248		}
249
250	1	$this->classNames = $classes;
251
252	1	return $classes;
253		}
254		}
255

doctrine / persistence

Pull Request — 1.3.x (#71)

AnnotationDriver::getAllClassNames() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like