composer/class-map-generator

Utilities to scan PHP code and generate class maps.

Maintainers

Details

github.com/composer/class-map-generator

Source

Issues

Fund package maintenance!
packagist.com
Tidelift
composer

Installs: 57 191 416

Dependents: 56

Suggesters: 1

Security: 0

Stars: 158

Watchers: 3

Forks: 13

Open Issues: 0

1.4.0 2024-10-03 18:14 UTC

Requires

Requires (Dev)

MIT 98bbf6780e56e0fd2404fe4b82eb665a0f93b783

classmap

This package is auto-updated.

Last update: 2024-10-27 21:15:00 UTC

README

Utilities to generate class maps and scan PHP code.

Continuous Integration

Installation

Install the latest version with:

composer require composer/class-map-generator

Requirements

  • PHP 7.2 is required.

Basic usage

If all you want is to scan a directory and extract a classmap with all classes/interfaces/traits/enums mapped to their paths, you can simply use:

use Composer\ClassMapGenerator\ClassMapGenerator;

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

For more advanced usage, you can instantiate a generator object and call scanPaths one or more time then call getClassMap to get a ClassMap object containing the resulting map + eventual warnings.

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
}

License

composer/class-map-generator is licensed under the MIT License, see the LICENSE file for details.