function ClassDeclarationSniff::processClose

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Classes/ClassDeclarationSniff.php \Drupal\Sniffs\Classes\ClassDeclarationSniff::processClose()
2. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PSR2/Sniffs/Classes/ClassDeclarationSniff.php \PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff::processClose()

Processes the closing section of a class declaration.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

Overrides ClassDeclarationSniff::processClose

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Classes/ClassDeclarationSniff.php, line 99

Class

ClassDeclarationSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes

Code

public function processClose(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if (isset($tokens[$stackPtr]['scope_closer']) === false) {
        return;
    }
    $closeBrace = $tokens[$stackPtr]['scope_closer'];
    // Check that the closing brace has one blank line after it.
    for ($nextContent = $closeBrace + 1; $nextContent < $phpcsFile->numTokens; $nextContent++) {
        // Ignore comments on the same line as the brace.
        if ($tokens[$nextContent]['line'] === $tokens[$closeBrace]['line'] && ($tokens[$nextContent]['code'] === T_WHITESPACE || $tokens[$nextContent]['code'] === T_COMMENT || isset(Tokens::$phpcsCommentTokens[$tokens[$nextContent]['code']]) === true)) {
            continue;
        }
        if ($tokens[$nextContent]['code'] !== T_WHITESPACE) {
            break;
        }
    }
    if ($nextContent === $phpcsFile->numTokens) {
        // Ignore the line check as this is the very end of the file.
        $difference = 1;
    }
    else {
        $difference = $tokens[$nextContent]['line'] - $tokens[$closeBrace]['line'] - 1;
    }
    $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, $closeBrace - 1, $stackPtr, true);
    if ($difference === -1 || $tokens[$lastContent]['line'] === $tokens[$closeBrace]['line']) {
        $error = 'Closing %s brace must be on a line by itself';
        $data = [
            $tokens[$stackPtr]['content'],
        ];
        $fix = $phpcsFile->addFixableError($error, $closeBrace, 'CloseBraceSameLine', $data);
        if ($fix === true) {
            if ($difference === -1) {
                $phpcsFile->fixer
                    ->addNewlineBefore($nextContent);
            }
            if ($tokens[$lastContent]['line'] === $tokens[$closeBrace]['line']) {
                $phpcsFile->fixer
                    ->addNewlineBefore($closeBrace);
            }
        }
    }
    else {
        if ($tokens[$closeBrace - 1]['code'] === T_WHITESPACE) {
            $prevContent = $tokens[$closeBrace - 1]['content'];
            if ($prevContent !== $phpcsFile->eolChar) {
                $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar));
                $spaces = strlen($blankSpace);
                if ($spaces !== 0) {
                    if ($tokens[$closeBrace - 1]['line'] !== $tokens[$closeBrace]['line']) {
                        $error = 'Expected 0 spaces before closing brace; newline found';
                        $phpcsFile->addError($error, $closeBrace, 'NewLineBeforeCloseBrace');
                    }
                    else {
                        $error = 'Expected 0 spaces before closing brace; %s found';
                        $data = [
                            $spaces,
                        ];
                        $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpaceBeforeCloseBrace', $data);
                        if ($fix === true) {
                            $phpcsFile->fixer
                                ->replaceToken($closeBrace - 1, '');
                        }
                    }
                }
            }
        }
    }
    
    //end if
    if ($difference !== -1 && $difference !== 1) {
        if ($tokens[$nextContent]['code'] === T_DOC_COMMENT_OPEN_TAG) {
            $next = $phpcsFile->findNext(T_WHITESPACE, $tokens[$nextContent]['comment_closer'] + 1, null, true);
            if ($next !== false && $tokens[$next]['code'] === T_FUNCTION) {
                return;
            }
        }
        $error = 'Closing brace of a %s must be followed by a single blank line; found %s';
        $data = [
            $tokens[$stackPtr]['content'],
            $difference,
        ];
        $fix = $phpcsFile->addFixableError($error, $closeBrace, 'NewlinesAfterCloseBrace', $data);
        if ($fix === true) {
            if ($difference === 0) {
                $first = $phpcsFile->findFirstOnLine([], $nextContent, true);
                $phpcsFile->fixer
                    ->addNewlineBefore($first);
            }
            else {
                $phpcsFile->fixer
                    ->beginChangeset();
                for ($i = $closeBrace + 1; $i < $nextContent; $i++) {
                    if ($tokens[$i]['line'] <= $tokens[$closeBrace]['line'] + 1) {
                        continue;
                    }
                    else {
                        if ($tokens[$i]['line'] === $tokens[$nextContent]['line']) {
                            break;
                        }
                    }
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
    }
    
    //end if
}