function MethodScopeSniff::processTokenWithinScope

Same name in this branch

1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Scope/MethodScopeSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\Scope\MethodScopeSniff::processTokenWithinScope()

Processes the function tokens within the class.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.:

int $stackPtr The position where the token was found.:

int $currScope The current scope opener token.:

Return value

void

Overrides AbstractScopeSniff::processTokenWithinScope

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Scope/MethodScopeSniff.php, line 51

Class

MethodScopeSniff

Verifies that class/interface/trait methods have scope modifiers.

Namespace

Drupal\Sniffs\Scope

Code

protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope) {
    $tokens = $phpcsFile->getTokens();
    $methodName = $phpcsFile->getDeclarationName($stackPtr);
    if ($methodName === null) {
        // Ignore closures.
        return;
    }
    if ($phpcsFile->hasCondition($stackPtr, T_FUNCTION) === true) {
        // Ignore nested functions.
        return;
    }
    $modifier = null;
    for ($i = $stackPtr - 1; $i > 0; $i--) {
        if ($tokens[$i]['line'] < $tokens[$stackPtr]['line']) {
            break;
        }
        else {
            if (isset(Tokens::$scopeModifiers[$tokens[$i]['code']]) === true) {
                $modifier = $i;
                break;
            }
        }
    }
    if ($modifier === null) {
        $error = 'Visibility must be declared on method "%s"';
        $data = [
            $methodName,
        ];
        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Missing', $data);
        if ($fix === true) {
            // No scope modifier means the method is public in PHP, fix that
            // to be explicitly public.
            $phpcsFile->fixer
                ->addContentBefore($stackPtr, 'public ');
        }
    }
}