rkr/class-finder

A tool to find full qualified class-names from a list of files

1.0.1 2022-08-16 20:45 UTC

Requires

• nikic/php-parser: ^4.14

Requires (Dev)

• phpstan/phpstan: ^1.8
• phpunit/phpunit: ^9.5

MIT

• class
• finder

README

You have to provide a list of file paths in which a php-class is to be searched for. Behind the scenes, nikic/php-parser is used to interpret the files. This means that the PHP files are not interpreted directly. This is much slower, than the approach, that haydenpierce/class-finder is using.

composer require rkr/class-finder

Examples

ClassFinder::findClassesFromDirectory

use Kir\ClassFinder\ClassFinder;

$startDir = __DIR__ . '/src';
$classNames = ClassFinder::findClassesFromDirectory($startDir);

print_r(iterator_to_array($classNames));
// Kir\ClassFinder\NodeVisitor
// Kir\ClassFinder\ClassFinder
// Kir\ClassFinder\ClassTools
// Kir\ClassFinder\ClassFinderResult
// Kir\ClassFinder\ClassFile

ClassFinder::findClassesFromIterableFileList

use Kir\ClassFinder\ClassFinder;

//region Gather the files
$startDir = __DIR__ . '/src';
$directory = new RecursiveDirectoryIterator($startDir, FilesystemIterator::FOLLOW_SYMLINKS | FilesystemIterator::SKIP_DOTS | FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_PATHNAME);
$iterator = new RecursiveIteratorIterator($directory);
$files = new CallbackFilterIterator($iterator, fn(string $path) => preg_match('{\\.p(hp\\d?|html)$}i', $path));
//endregion

$classNames = ClassFinder::findClassesFromIterableFileList($files);

print_r(iterator_to_array($classNames));
// Kir\ClassFinder\NodeVisitor
// Kir\ClassFinder\ClassFinder
// Kir\ClassFinder\ClassTools
// Kir\ClassFinder\ClassFinderResult
// Kir\ClassFinder\ClassFile