class AbstractFullyQualifiedGlobalReference
@internal
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Namespaces\AbstractFullyQualifiedGlobalReference implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of AbstractFullyQualifiedGlobalReference
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Namespaces/ AbstractFullyQualifiedGlobalReference.php, line 25
Namespace
SlevomatCodingStandard\Sniffs\NamespacesView source
abstract class AbstractFullyQualifiedGlobalReference implements Sniff {
public const CODE_NON_FULLY_QUALIFIED = 'NonFullyQualified';
/** @var list<string> */
public $exclude = [];
/** @var list<string> */
public $include = [];
/** @var list<string>|null */
private $normalizedExclude;
/** @var list<string>|null */
private $normalizedInclude;
protected abstract function getNotFullyQualifiedMessage() : string;
protected abstract function isCaseSensitive() : bool;
protected abstract function isValidType(ReferencedName $name) : bool;
/**
* @return array<int, (int|string)>
*/
public function register() : array {
return [
T_OPEN_TAG,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $openTagPointer
*/
public function process(File $phpcsFile, $openTagPointer) : void {
if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) {
return;
}
if (TokenHelper::findNext($phpcsFile, T_OPEN_USE_GROUP, $openTagPointer) !== null) {
return;
}
$tokens = $phpcsFile->getTokens();
$namespacePointers = NamespaceHelper::getAllNamespacesPointers($phpcsFile);
$referencedNames = ReferencedNameHelper::getAllReferencedNames($phpcsFile, $openTagPointer);
$include = array_flip($this->getNormalizedInclude());
$exclude = array_flip($this->getNormalizedExclude());
foreach ($referencedNames as $referencedName) {
$name = $referencedName->getNameAsReferencedInFile();
$namePointer = $referencedName->getStartPointer();
if (!$this->isValidType($referencedName)) {
continue;
}
if (NamespaceHelper::isFullyQualifiedName($name)) {
continue;
}
if (NamespaceHelper::hasNamespace($name)) {
continue;
}
if ($namespacePointers === []) {
continue;
}
$canonicalName = $this->isCaseSensitive() ? $name : strtolower($name);
$useStatements = UseStatementHelper::getUseStatementsForPointer($phpcsFile, $namePointer);
if (array_key_exists(UseStatement::getUniqueId($referencedName->getType(), $canonicalName), $useStatements)) {
$fullyQualifiedName = NamespaceHelper::resolveName($phpcsFile, $name, $referencedName->getType(), $namePointer);
if (NamespaceHelper::hasNamespace($fullyQualifiedName)) {
continue;
}
}
if ($include !== [] && !array_key_exists($canonicalName, $include)) {
continue;
}
if (array_key_exists($canonicalName, $exclude)) {
continue;
}
$fix = $phpcsFile->addFixableError(sprintf($this->getNotFullyQualifiedMessage(), $tokens[$namePointer]['content']), $namePointer, self::CODE_NON_FULLY_QUALIFIED);
if (!$fix) {
continue;
}
$phpcsFile->fixer
->beginChangeset();
$phpcsFile->fixer
->addContentBefore($namePointer, NamespaceHelper::NAMESPACE_SEPARATOR);
$phpcsFile->fixer
->endChangeset();
}
}
/**
* @return list<string>
*/
protected function getNormalizedInclude() : array {
if ($this->normalizedInclude === null) {
$this->normalizedInclude = $this->normalizeNames($this->include);
}
return $this->normalizedInclude;
}
/**
* @return list<string>
*/
private function getNormalizedExclude() : array {
if ($this->normalizedExclude === null) {
$this->normalizedExclude = $this->normalizeNames($this->exclude);
}
return $this->normalizedExclude;
}
/**
* @param list<string> $names
* @return list<string>
*/
private function normalizeNames(array $names) : array {
$names = SniffSettingsHelper::normalizeArray($names);
if (!$this->isCaseSensitive()) {
$names = array_map(static function (string $name) : string {
return strtolower($name);
}, $names);
}
return $names;
}
}