ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: opt / cpanel / ea-wappspector / vendor / slevomat / coding-standard / SlevomatCodingStandard / Sniffs / Files

<?php declare(strict_types = 1);

namespace SlevomatCodingStandard\Sniffs\Files;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\ClassHelper;
use SlevomatCodingStandard\Helpers\NamespaceHelper;
use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
use SlevomatCodingStandard\Helpers\StringHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use function count;
use function explode;
use function min;
use function sprintf;
use function str_replace;
use function strcasecmp;
use function strlen;
use function substr;
use function ucfirst;
use function uksort;
use const DIRECTORY_SEPARATOR;
use const T_STRING;

class TypeNameMatchesFileNameSniff implements Sniff
{

public const CODE_NO_MATCH_BETWEEN_TYPE_NAME_AND_FILE_NAME = 'NoMatchBetweenTypeNameAndFileName';

/** @var array<string, string> */
	public array $rootNamespaces = [];

/** @var list<string> */
	public array $skipDirs = [];

/** @var list<string> */
	public array $ignoredNamespaces = [];

/** @var list<string> */
	public array $extensions = ['php'];

/** @var array<string, string>|null */
	private ?array $normalizedRootNamespaces = null;

/** @var list<string>|null */
	private ?array $normalizedSkipDirs = null;

/** @var list<string>|null */
	private ?array $normalizedIgnoredNamespaces = null;

/** @var list<string>|null */
	private ?array $normalizedExtensions = null;

private ?FilepathNamespaceExtractor $namespaceExtractor = null;

/**
	 * @return array<int, (int|string)>
	 */
	public function register(): array
	{
		return TokenHelper::CLASS_TYPE_TOKEN_CODES;
	}

/**
	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
	 * @param int $typePointer
	 */
	public function process(File $phpcsFile, $typePointer): void
	{
		$tokens = $phpcsFile->getTokens();

/** @var int $namePointer */
		$namePointer = TokenHelper::findNext($phpcsFile, T_STRING, $typePointer + 1);

$typeName = NamespaceHelper::normalizeToCanonicalName(ClassHelper::getFullyQualifiedName($phpcsFile, $typePointer));

foreach ($this->getIgnoredNamespaces() as $ignoredNamespace) {
			if (!StringHelper::startsWith($typeName, $ignoredNamespace . '\\')) {
				continue;
			}

return;
		}

$filename = str_replace('/', DIRECTORY_SEPARATOR, $phpcsFile->getFilename());
		$basePath = str_replace('/', DIRECTORY_SEPARATOR, $phpcsFile->config->basepath ?? '');
		if ($basePath !== '' && StringHelper::startsWith($filename, $basePath)) {
			$filename = substr($filename, strlen($basePath));
		}

$expectedTypeName = $this->getNamespaceExtractor()->getTypeNameFromProjectPath($filename);
		if ($typeName === $expectedTypeName) {
			return;
		}

$phpcsFile->addError(
			sprintf(
				'%s name %s does not match filepath %s.',
				ucfirst($tokens[$typePointer]['content']),
				$typeName,
				$phpcsFile->getFilename(),
			),
			$namePointer,
			self::CODE_NO_MATCH_BETWEEN_TYPE_NAME_AND_FILE_NAME,
		);
	}

/**
	 * @return array<string, string> path(string) => namespace
	 */
	private function getRootNamespaces(): array
	{
		if ($this->normalizedRootNamespaces === null) {
			/** @var array<string, string> $normalizedRootNamespaces */
			$normalizedRootNamespaces = SniffSettingsHelper::normalizeAssociativeArray($this->rootNamespaces);
			$this->normalizedRootNamespaces = $normalizedRootNamespaces;
			uksort($this->normalizedRootNamespaces, static function (string $a, string $b): int {
				$aParts = explode('/', str_replace('\\', '/', $a));
				$bParts = explode('/', str_replace('\\', '/', $b));

$minPartsCount = min(count($aParts), count($bParts));
				for ($i = 0; $i < $minPartsCount; $i++) {
					$comparison = strcasecmp($bParts[$i], $aParts[$i]);
					if ($comparison === 0) {
						continue;
					}

return $comparison;
				}

return count($bParts) <=> count($aParts);
			});
		}

return $this->normalizedRootNamespaces;
	}

/**
	 * @return list<string>
	 */
	private function getSkipDirs(): array
	{
		$this->normalizedSkipDirs ??= SniffSettingsHelper::normalizeArray($this->skipDirs);

return $this->normalizedSkipDirs;
	}

/**
	 * @return list<string>
	 */
	private function getIgnoredNamespaces(): array
	{
		$this->normalizedIgnoredNamespaces ??= SniffSettingsHelper::normalizeArray($this->ignoredNamespaces);

return $this->normalizedIgnoredNamespaces;
	}

/**
	 * @return list<string>
	 */
	private function getExtensions(): array
	{
		$this->normalizedExtensions ??= SniffSettingsHelper::normalizeArray($this->extensions);

return $this->normalizedExtensions;
	}

private function getNamespaceExtractor(): FilepathNamespaceExtractor
	{
		$this->namespaceExtractor ??= new FilepathNamespaceExtractor(
			$this->getRootNamespaces(),
			$this->getSkipDirs(),
			$this->getExtensions(),
		);

return $this->namespaceExtractor;
	}

}

[+] ..
[-] FileLengthSniff.php [edit]
[-] TypeNameMatchesFileNameSniff.php [edit]
[-] FilepathNamespaceExtractor.php [edit]
[-] LineLengthSniff.php [edit]