class TraitUseDeclarationSniff
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Classes\TraitUseDeclarationSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of TraitUseDeclarationSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Classes/ TraitUseDeclarationSniff.php, line 19
Namespace
SlevomatCodingStandard\Sniffs\ClassesView source
class TraitUseDeclarationSniff implements Sniff {
public const CODE_MULTIPLE_TRAITS_PER_DECLARATION = 'MultipleTraitsPerDeclaration';
/**
* @return array<int, (int|string)>
*/
public function register() : array {
return [
T_CLASS,
T_ANON_CLASS,
T_TRAIT,
T_ENUM,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $classPointer
*/
public function process(File $phpcsFile, $classPointer) : void {
$usePointers = ClassHelper::getTraitUsePointers($phpcsFile, $classPointer);
foreach ($usePointers as $usePointer) {
$this->checkDeclaration($phpcsFile, $usePointer);
}
}
private function checkDeclaration(File $phpcsFile, int $usePointer) : void {
$commaPointer = TokenHelper::findNextLocal($phpcsFile, T_COMMA, $usePointer + 1);
if ($commaPointer === null) {
return;
}
$endPointer = TokenHelper::findNext($phpcsFile, [
T_OPEN_CURLY_BRACKET,
T_SEMICOLON,
], $usePointer + 1);
$tokens = $phpcsFile->getTokens();
if ($tokens[$endPointer]['code'] === T_OPEN_CURLY_BRACKET) {
$phpcsFile->addError('Multiple traits per use statement are forbidden.', $usePointer, self::CODE_MULTIPLE_TRAITS_PER_DECLARATION);
return;
}
$fix = $phpcsFile->addFixableError('Multiple traits per use statement are forbidden.', $usePointer, self::CODE_MULTIPLE_TRAITS_PER_DECLARATION);
if (!$fix) {
return;
}
$indentation = '';
$currentPointer = $usePointer - 1;
while ($tokens[$currentPointer]['code'] === T_WHITESPACE && $tokens[$currentPointer]['content'] !== $phpcsFile->eolChar) {
$indentation .= $tokens[$currentPointer]['content'];
$currentPointer--;
}
$phpcsFile->fixer
->beginChangeset();
$otherCommaPointers = TokenHelper::findNextAll($phpcsFile, T_COMMA, $usePointer + 1, $endPointer);
foreach ($otherCommaPointers as $otherCommaPointer) {
$pointerAfterComma = TokenHelper::findNextEffective($phpcsFile, $otherCommaPointer + 1);
FixerHelper::change($phpcsFile, $otherCommaPointer, $pointerAfterComma - 1, ';' . $phpcsFile->eolChar . $indentation . 'use ');
}
$phpcsFile->fixer
->endChangeset();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
TraitUseDeclarationSniff::checkDeclaration | private | function | ||
TraitUseDeclarationSniff::CODE_MULTIPLE_TRAITS_PER_DECLARATION | public | constant | ||
TraitUseDeclarationSniff::process | public | function | * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * |
Overrides Sniff::process |
TraitUseDeclarationSniff::register | public | function | * | Overrides Sniff::register |