psalm/src/Psalm/FileBasedPluginAdapter.php

<?php

namespace Psalm;

use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\Scanner\FileScanner;
use Psalm\Plugin\PluginEntryPointInterface;
use Psalm\Plugin\RegistrationInterface;
use SimpleXMLElement;
use UnexpectedValueException;

use function assert;
use function class_exists;
use function reset;
use function str_replace;

use const DIRECTORY_SEPARATOR;

/** @internal */
final class FileBasedPluginAdapter implements PluginEntryPointInterface
{
    private string $path;

    private Codebase $codebase;

    private Config $config;

    public function __construct(string $path, Config $config, Codebase $codebase)
    {
        if (!$path) {
            throw new UnexpectedValueException('$path cannot be empty');
        }

        $this->path = $path;
        $this->config = $config;
        $this->codebase = $codebase;
    }

    public function __invoke(RegistrationInterface $registration, ?SimpleXMLElement $config = null): void
    {
        $fq_class_name = $this->getPluginClassForPath($this->path);

        /** @psalm-suppress UnresolvableInclude */
        require_once($this->path);

        assert(class_exists($fq_class_name));

        $registration->registerHooksFromClass($fq_class_name);
    }

    private function getPluginClassForPath(string $path): string
    {
        $codebase = $this->codebase;

        $path = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $path);

        $file_storage = $codebase->createFileStorageForPath($path);
        $file_to_scan = new FileScanner($path, $this->config->shortenFileName($path), true);
        $file_to_scan->scan(
            $codebase,
            $file_storage,
        );

        $declared_classes = ClassLikeAnalyzer::getClassesForFile($codebase, $path);

        return reset($declared_classes);
    }
}