function UselessVariableSniff::process

* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

Parameters

int $returnPointer:

Overrides Sniff::process

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php, line 68

Class

UselessVariableSniff

Namespace

SlevomatCodingStandard\Sniffs\Variables

Code

public function process(File $phpcsFile, $returnPointer) : void {
    $tokens = $phpcsFile->getTokens();
    
    /** @var int $variablePointer */
    $variablePointer = TokenHelper::findNextEffective($phpcsFile, $returnPointer + 1);
    if ($tokens[$variablePointer]['code'] !== T_VARIABLE) {
        return;
    }
    $returnSemicolonPointer = TokenHelper::findNextEffective($phpcsFile, $variablePointer + 1);
    if ($tokens[$returnSemicolonPointer]['code'] !== T_SEMICOLON) {
        return;
    }
    $variableName = $tokens[$variablePointer]['content'];
    $functionPointer = $this->findFunctionPointer($phpcsFile, $variablePointer);
    if ($functionPointer !== null) {
        if ($this->isReturnedByReference($phpcsFile, $functionPointer)) {
            return;
        }
        if ($this->isStaticVariable($phpcsFile, $functionPointer, $variablePointer, $variableName)) {
            return;
        }
        if ($this->isFunctionParameter($phpcsFile, $functionPointer, $variableName)) {
            return;
        }
    }
    $previousVariablePointer = $this->findPreviousVariablePointer($phpcsFile, $returnPointer, $variableName);
    if ($previousVariablePointer === null) {
        return;
    }
    if (!$this->isAssignmentToVariable($phpcsFile, $previousVariablePointer)) {
        return;
    }
    if ($this->isAssignedInControlStructure($phpcsFile, $previousVariablePointer)) {
        return;
    }
    if ($this->isAssignedInFunctionCall($phpcsFile, $previousVariablePointer)) {
        return;
    }
    if ($this->hasVariableVarAnnotation($phpcsFile, $previousVariablePointer)) {
        return;
    }
    if ($this->hasAnotherAssignmentBefore($phpcsFile, $previousVariablePointer, $variableName)) {
        return;
    }
    if (!$this->areBothPointersNearby($phpcsFile, $previousVariablePointer, $returnPointer)) {
        return;
    }
    $errorParameters = [
        sprintf('Useless variable %s.', $variableName),
        $previousVariablePointer,
        self::CODE_USELESS_VARIABLE,
    ];
    $pointerBeforePreviousVariable = TokenHelper::findPreviousEffective($phpcsFile, $previousVariablePointer - 1);
    if (!in_array($tokens[$pointerBeforePreviousVariable]['code'], [
        T_SEMICOLON,
        T_OPEN_CURLY_BRACKET,
        T_CLOSE_CURLY_BRACKET,
    ], true) && TokenHelper::findNextEffective($phpcsFile, $returnSemicolonPointer + 1) !== null) {
        $phpcsFile->addError(...$errorParameters);
        return;
    }
    $fix = $phpcsFile->addFixableError(...$errorParameters);
    if (!$fix) {
        return;
    }
    
    /** @var int $assignmentPointer */
    $assignmentPointer = TokenHelper::findNextEffective($phpcsFile, $previousVariablePointer + 1);
    $assignmentFixerMapping = [
        T_PLUS_EQUAL => '+',
        T_MINUS_EQUAL => '-',
        T_MUL_EQUAL => '*',
        T_DIV_EQUAL => '/',
        T_POW_EQUAL => '**',
        T_MOD_EQUAL => '%',
        T_AND_EQUAL => '&',
        T_OR_EQUAL => '|',
        T_XOR_EQUAL => '^',
        T_SL_EQUAL => '<<',
        T_SR_EQUAL => '>>',
        T_CONCAT_EQUAL => '.',
    ];
    $previousVariableSemicolonPointer = $this->findSemicolon($phpcsFile, $previousVariablePointer);
    $phpcsFile->fixer
        ->beginChangeset();
    if ($tokens[$assignmentPointer]['code'] === T_EQUAL) {
        FixerHelper::change($phpcsFile, $previousVariablePointer, $assignmentPointer, 'return');
    }
    else {
        $phpcsFile->fixer
            ->addContentBefore($previousVariablePointer, 'return ');
        $phpcsFile->fixer
            ->replaceToken($assignmentPointer, $assignmentFixerMapping[$tokens[$assignmentPointer]['code']]);
    }
    FixerHelper::removeBetweenIncluding($phpcsFile, $previousVariableSemicolonPointer + 1, $returnSemicolonPointer);
    $phpcsFile->fixer
        ->endChangeset();
}