function VariableAnalysisSniff::warnAboutUnusedVariable

* Register warnings for a variable that is defined but not used. * *

Parameters

File $phpcsFile: * @param VariableInfo $varInfo * * @return void

1 call to VariableAnalysisSniff::warnAboutUnusedVariable()

VariableAnalysisSniff::processScopeCloseForVariable in vendor/sirbrillig/phpcs-variable-analysis/VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php

* Warn about an unused variable if it has not been used within a scope. * *

File

vendor/sirbrillig/phpcs-variable-analysis/VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php, line 1997

Class

VariableAnalysisSniff

Namespace

VariableAnalysis\Sniffs\CodeAnalysis

Code

protected function warnAboutUnusedVariable(File $phpcsFile, VariableInfo $varInfo) {
    foreach (array_unique($varInfo->allAssignments) as $indexForWarning) {
        Helpers::debug("variable '{$varInfo->name}' at end of scope looks unused");
        $phpcsFile->addWarning('Unused %s %s.', $indexForWarning, 'UnusedVariable', [
            VariableInfo::$scopeTypeDescriptions[$varInfo->scopeType ?: ScopeType::LOCAL],
            "\${$varInfo->name}",
        ]);
    }
}