composer/class-map-generator

用于扫描 PHP 代码并生成类映射的工具。

1.3.4 2024-06-12 14:13 UTC

README

用于生成类映射和扫描 PHP 代码的工具。

Continuous Integration

安装

使用以下命令安装最新版本:

$ composer require composer/class-map-generator

要求

  • 需要 PHP 7.2。

基本用法

如果您只想扫描一个目录并提取一个包含所有类、接口、特质、枚举及其路径的类映射,您可以简单使用

use Composer\ClassMapGenerator\ClassMapGenerator;

$map = ClassMapGenerator::createMap('path/to/scan');
foreach ($map as $symbol => $path) {
    // do your thing
}

对于更高级的使用,您可以实例化一个生成器对象,调用 scanPaths 一次或多次,然后调用 getClassMap 获取一个包含结果映射和潜在警告的 ClassMap 对象。

use Composer\ClassMapGenerator\ClassMapGenerator;

$generator = new ClassMapGenerator;
$generator->scanPaths('path/to/scan');
$generator->scanPaths('path/to/scan2');

$classMap = $generator->getClassMap();
$classMap->sort(); // optionally sort classes alphabetically
foreach ($classMap->getMap() as $symbol => $path) {
    // do your thing
}

foreach ($classMap->getAmbiguousClasses() as $symbol => $paths) {
    // warn user about ambiguous class resolution
}

许可证

composer/class-map-generator 在 MIT 许可证下授权,有关详细信息,请参阅 LICENSE 文件。