function MethodDeclarationSniff::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/squizlabs/php_codesniffer/src/Standards/PSR2/Sniffs/Methods/MethodDeclarationSniff.php, line 39

Class

MethodDeclarationSniff

Namespace

PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods

Code

protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope) {
    $tokens = $phpcsFile->getTokens();
    // Determine if this is a function which needs to be examined.
    $conditions = $tokens[$stackPtr]['conditions'];
    end($conditions);
    $deepestScope = key($conditions);
    if ($deepestScope !== $currScope) {
        return;
    }
    $methodName = $phpcsFile->getDeclarationName($stackPtr);
    if ($methodName === null) {
        // Ignore closures.
        return;
    }
    if ($methodName[0] === '_' && isset($methodName[1]) === true && $methodName[1] !== '_') {
        $error = 'Method name "%s" should not be prefixed with an underscore to indicate visibility';
        $data = [
            $methodName,
        ];
        $phpcsFile->addWarning($error, $stackPtr, 'Underscore', $data);
    }
    $visibility = 0;
    $static = 0;
    $abstract = 0;
    $final = 0;
    $find = Tokens::$methodPrefixes + Tokens::$emptyTokens;
    $prev = $phpcsFile->findPrevious($find, $stackPtr - 1, null, true);
    $prefix = $stackPtr;
    while (($prefix = $phpcsFile->findPrevious(Tokens::$methodPrefixes, $prefix - 1, $prev)) !== false) {
        switch ($tokens[$prefix]['code']) {
            case T_STATIC:
                $static = $prefix;
                break;
            case T_ABSTRACT:
                $abstract = $prefix;
                break;
            case T_FINAL:
                $final = $prefix;
                break;
            default:
                $visibility = $prefix;
                break;
        }
    }
    $fixes = [];
    if ($visibility !== 0 && $final > $visibility) {
        $error = 'The final declaration must precede the visibility declaration';
        $fix = $phpcsFile->addFixableError($error, $final, 'FinalAfterVisibility');
        if ($fix === true) {
            $fixes[$final] = '';
            $fixes[$final + 1] = '';
            if (isset($fixes[$visibility]) === true) {
                $fixes[$visibility] = 'final ' . $fixes[$visibility];
            }
            else {
                $fixes[$visibility] = 'final ' . $tokens[$visibility]['content'];
            }
        }
    }
    if ($visibility !== 0 && $abstract > $visibility) {
        $error = 'The abstract declaration must precede the visibility declaration';
        $fix = $phpcsFile->addFixableError($error, $abstract, 'AbstractAfterVisibility');
        if ($fix === true) {
            $fixes[$abstract] = '';
            $fixes[$abstract + 1] = '';
            if (isset($fixes[$visibility]) === true) {
                $fixes[$visibility] = 'abstract ' . $fixes[$visibility];
            }
            else {
                $fixes[$visibility] = 'abstract ' . $tokens[$visibility]['content'];
            }
        }
    }
    if ($static !== 0 && $static < $visibility) {
        $error = 'The static declaration must come after the visibility declaration';
        $fix = $phpcsFile->addFixableError($error, $static, 'StaticBeforeVisibility');
        if ($fix === true) {
            $fixes[$static] = '';
            $fixes[$static + 1] = '';
            if (isset($fixes[$visibility]) === true) {
                $fixes[$visibility] .= ' static';
            }
            else {
                $fixes[$visibility] = $tokens[$visibility]['content'] . ' static';
            }
        }
    }
    // Batch all the fixes together to reduce the possibility of conflicts.
    if (empty($fixes) === false) {
        $phpcsFile->fixer
            ->beginChangeset();
        foreach ($fixes as $stackPtr => $content) {
            $phpcsFile->fixer
                ->replaceToken($stackPtr, $content);
        }
        $phpcsFile->fixer
            ->endChangeset();
    }
}