class UnusedInheritedVariablePassedToClosureSniff
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Functions\UnusedInheritedVariablePassedToClosureSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of UnusedInheritedVariablePassedToClosureSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Functions/ UnusedInheritedVariablePassedToClosureSniff.php, line 20
Namespace
SlevomatCodingStandard\Sniffs\FunctionsView source
class UnusedInheritedVariablePassedToClosureSniff implements Sniff {
public const CODE_UNUSED_INHERITED_VARIABLE = 'UnusedInheritedVariable';
/**
* @return array<int, (int|string)>
*/
public function register() : array {
return [
T_USE,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $usePointer
*/
public function process(File $phpcsFile, $usePointer) : void {
$tokens = $phpcsFile->getTokens();
/** @var int $parenthesisOpenerPointer */
$parenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1);
if ($tokens[$parenthesisOpenerPointer]['code'] !== T_OPEN_PARENTHESIS) {
return;
}
/** @var int $closurePointer */
$closurePointer = TokenHelper::findPrevious($phpcsFile, T_CLOSURE, $usePointer - 1);
$currentPointer = $parenthesisOpenerPointer + 1;
do {
$variablePointer = TokenHelper::findNext($phpcsFile, T_VARIABLE, $currentPointer, $tokens[$parenthesisOpenerPointer]['parenthesis_closer']);
if ($variablePointer === null) {
break;
}
$this->checkVariableUsage($phpcsFile, $usePointer, $parenthesisOpenerPointer, $tokens[$parenthesisOpenerPointer]['parenthesis_closer'], $variablePointer, $closurePointer);
$currentPointer = $variablePointer + 1;
} while (true);
}
private function checkVariableUsage(File $phpcsFile, int $usePointer, int $useParenthesisOpenerPointer, int $useParenthesisCloserPointer, int $variablePointer, int $scopeOwnerPointer) : void {
$tokens = $phpcsFile->getTokens();
if (VariableHelper::isUsedInScope($phpcsFile, $scopeOwnerPointer, $variablePointer)) {
return;
}
$fix = $phpcsFile->addFixableError(sprintf('Unused inherited variable %s passed to closure.', $tokens[$variablePointer]['content']), $variablePointer, self::CODE_UNUSED_INHERITED_VARIABLE);
if (!$fix) {
return;
}
$fixStartPointer = $variablePointer;
do {
if ($tokens[$fixStartPointer - 1]['code'] === T_OPEN_PARENTHESIS) {
break;
}
$fixStartPointer--;
if ($tokens[$fixStartPointer]['code'] === T_COMMA) {
break;
}
} while (true);
$fixEndPointer = $variablePointer;
do {
if ($tokens[$fixEndPointer + 1]['code'] === T_CLOSE_PARENTHESIS) {
break;
}
if ($tokens[$fixEndPointer + 1]['code'] === T_COMMA && $tokens[$fixStartPointer]['code'] === T_COMMA) {
break;
}
if (in_array($tokens[$fixEndPointer + 1]['code'], [
T_VARIABLE,
T_BITWISE_AND,
], true)) {
break;
}
$fixEndPointer++;
} while (true);
$phpcsFile->fixer
->beginChangeset();
FixerHelper::removeBetweenIncluding($phpcsFile, $fixStartPointer, $fixEndPointer);
$emptyUse = true;
for ($i = $useParenthesisOpenerPointer + 1; $i < $useParenthesisCloserPointer; $i++) {
if ($phpcsFile->fixer
->getTokenContent($i) !== '') {
$emptyUse = false;
break;
}
}
if ($emptyUse) {
FixerHelper::removeBetweenIncluding($phpcsFile, $usePointer, $useParenthesisCloserPointer);
}
$phpcsFile->fixer
->endChangeset();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
UnusedInheritedVariablePassedToClosureSniff::checkVariableUsage | private | function | ||
UnusedInheritedVariablePassedToClosureSniff::CODE_UNUSED_INHERITED_VARIABLE | public | constant | ||
UnusedInheritedVariablePassedToClosureSniff::process | public | function | * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * |
Overrides Sniff::process |
UnusedInheritedVariablePassedToClosureSniff::register | public | function | * | Overrides Sniff::register |