functions.php ➔ listClassesInDirectories() - Code Metrics - Inspection of "Add listClassesInDirectories function" - WyriHaximus/php-list-classes-in-directory - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Saif Eddin

created 2018-10-13 22:31 UTC

functions.php ➔ listClassesInDirectories() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	15
ccs	8
cts	8
cp	1
crap	2
rs	9.7666
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace WyriHaximus;

use Roave\BetterReflection\BetterReflection;
use Roave\BetterReflection\Reflector\ClassReflector;
use Roave\BetterReflection\SourceLocator\Type\AggregateSourceLocator;
use Roave\BetterReflection\SourceLocator\Type\AutoloadSourceLocator;
use Roave\BetterReflection\SourceLocator\Type\DirectoriesSourceLocator;

/**
 * get a list of all classes in the given directories.
 *
 * Based on: https://github.com/Roave/BetterReflection/blob/396a07c9d276cb9ffba581b24b2dadbb542d542e/demo/parsing-whole-directory/example2.php.
 *
 * @param string[] $directories
 *
 * @return iterable
 */
function listClassesInDirectories(string ...$directories): iterable
{
    $sourceLocator = new AggregateSourceLocator([
        new DirectoriesSourceLocator(
            $directories,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            (new BetterReflection())->astLocator()
        ),
        // ↓ required to autoload parent classes/interface from another directory than /src (e.g. /vendor)
        new AutoloadSourceLocator((new BetterReflection())->astLocator()),
    ]);

    foreach ((new ClassReflector($sourceLocator))->getAllClasses() as $class) {
        yield $class->getName();
    }
}

/**
 * get a list of all classes in the given direcotory.
 *
 * @param string $directory
 *
 * @return iterable
 */
function listClassesInDirectory(string $directory): iterable
{
    yield from listClassesInDirectories($directory);
}


1		<?php declare(strict_types=1);
2
3		namespace WyriHaximus;
4
5		use Roave\BetterReflection\BetterReflection;
6		use Roave\BetterReflection\Reflector\ClassReflector;
7		use Roave\BetterReflection\SourceLocator\Type\AggregateSourceLocator;
8		use Roave\BetterReflection\SourceLocator\Type\AutoloadSourceLocator;
9		use Roave\BetterReflection\SourceLocator\Type\DirectoriesSourceLocator;
10
11		/**
12		* get a list of all classes in the given directories.
13		*
14		* Based on: https://github.com/Roave/BetterReflection/blob/396a07c9d276cb9ffba581b24b2dadbb542d542e/demo/parsing-whole-directory/example2.php.
15		*
16		* @param string[] $directories
17		*
18		* @return iterable
19		*/
20		function listClassesInDirectories(string ...$directories): iterable
21		{
22	2	$sourceLocator = new AggregateSourceLocator([
23	2	new DirectoriesSourceLocator(
24	2	$directories,
		0 ignored issues – show Documentation introduced 2018-10-13 22:28 UTC by Report Bug Copy Issue Report `$directories` is of type `array<integer,array<integer,string>>`, but the function expects a `array<integer,string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
25	2	(new BetterReflection())->astLocator()
26		),
27		// ↓ required to autoload parent classes/interface from another directory than /src (e.g. /vendor)
28	2	new AutoloadSourceLocator((new BetterReflection())->astLocator()),
29		]);
30
31	2	foreach ((new ClassReflector($sourceLocator))->getAllClasses() as $class) {
32	2	yield $class->getName();
33		}
34	2	}
35
36		/**
37		* get a list of all classes in the given direcotory.
38		*
39		* @param string $directory
40		*
41		* @return iterable
42		*/
43		function listClassesInDirectory(string $directory): iterable
44		{
45	1	yield from listClassesInDirectories($directory);
46		}
47

WyriHaximus / php-list-classes-in-directory

GitHub Access Token became invalid

Pull Request — master (#1)

functions.php ➔ listClassesInDirectories() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like