function Helpers::isFunctionBodyEmpty

* Return true if the function body is empty or contains only `return;` * *

Parameters

File $phpcsFile: * @param int $stackPtr The index of the function keyword. * * @return bool

1 call to Helpers::isFunctionBodyEmpty()

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/Lib/Helpers.php, line 1756

Class

Helpers

Namespace

VariableAnalysis\Lib

Code

public static function isFunctionBodyEmpty(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if ($tokens[$stackPtr]['code'] !== T_FUNCTION) {
        return false;
    }
    $functionScopeStart = $tokens[$stackPtr]['scope_opener'];
    $functionScopeEnd = $tokens[$stackPtr]['scope_closer'];
    $tokensToIgnore = array_merge(Tokens::$emptyTokens, [
        T_RETURN,
        T_SEMICOLON,
        T_OPEN_CURLY_BRACKET,
        T_CLOSE_CURLY_BRACKET,
    ]);
    for ($i = $functionScopeStart; $i < $functionScopeEnd; $i++) {
        if (!in_array($tokens[$i]['code'], $tokensToIgnore, true)) {
            return false;
        }
    }
    return true;
}