132 lines
3.2 KiB
PHP
132 lines
3.2 KiB
PHP
<?php declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of Composer.
|
|
*
|
|
* (c) Nils Adermann <naderman@naderman.de>
|
|
* Jordi Boggiano <j.boggiano@seld.be>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Composer\ClassMapGenerator;
|
|
|
|
/**
|
|
* @author Jordi Boggiano <j.boggiano@seld.be>
|
|
*/
|
|
class ClassMap implements \Countable
|
|
{
|
|
/**
|
|
* @var array<class-string, non-empty-string>
|
|
*/
|
|
public $map = [];
|
|
|
|
/**
|
|
* @var array<class-string, array<non-empty-string>>
|
|
*/
|
|
private $ambiguousClasses = [];
|
|
|
|
/**
|
|
* @var string[]
|
|
*/
|
|
private $psrViolations = [];
|
|
|
|
/**
|
|
* Returns the class map, which is a list of paths indexed by class name
|
|
*
|
|
* @return array<class-string, non-empty-string>
|
|
*/
|
|
public function getMap(): array
|
|
{
|
|
return $this->map;
|
|
}
|
|
|
|
/**
|
|
* Returns warning strings containing details about PSR-0/4 violations that were detected
|
|
*
|
|
* Violations are for ex a class which is in the wrong file/directory and thus should not be
|
|
* found using psr-0/psr-4 autoloading but was found by the ClassMapGenerator as it scans all files.
|
|
*
|
|
* This is only happening when scanning paths using psr-0/psr-4 autoload type. Classmap type
|
|
* always accepts every class as it finds it.
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getPsrViolations(): array
|
|
{
|
|
return $this->psrViolations;
|
|
}
|
|
|
|
/**
|
|
* A map of class names to their list of ambiguous paths
|
|
*
|
|
* This occurs when the same class can be found in several files
|
|
*
|
|
* To get the path the class is being mapped to, call getClassPath
|
|
*
|
|
* @return array<class-string, array<non-empty-string>>
|
|
*/
|
|
public function getAmbiguousClasses(): array
|
|
{
|
|
return $this->ambiguousClasses;
|
|
}
|
|
|
|
/**
|
|
* Sorts the class map alphabetically by class names
|
|
*/
|
|
public function sort(): void
|
|
{
|
|
ksort($this->map);
|
|
}
|
|
|
|
/**
|
|
* @param class-string $className
|
|
* @param non-empty-string $path
|
|
*/
|
|
public function addClass(string $className, string $path): void
|
|
{
|
|
$this->map[$className] = $path;
|
|
}
|
|
|
|
/**
|
|
* @param class-string $className
|
|
* @return non-empty-string
|
|
*/
|
|
public function getClassPath(string $className): string
|
|
{
|
|
if (!isset($this->map[$className])) {
|
|
throw new \OutOfBoundsException('Class '.$className.' is not present in the map');
|
|
}
|
|
|
|
return $this->map[$className];
|
|
}
|
|
|
|
/**
|
|
* @param class-string $className
|
|
*/
|
|
public function hasClass(string $className): bool
|
|
{
|
|
return isset($this->map[$className]);
|
|
}
|
|
|
|
public function addPsrViolation(string $warning): void
|
|
{
|
|
$this->psrViolations[] = $warning;
|
|
}
|
|
|
|
/**
|
|
* @param class-string $className
|
|
* @param non-empty-string $path
|
|
*/
|
|
public function addAmbiguousClass(string $className, string $path): void
|
|
{
|
|
$this->ambiguousClasses[$className][] = $path;
|
|
}
|
|
|
|
public function count(): int
|
|
{
|
|
return \count($this->map);
|
|
}
|
|
}
|