Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ClassDefinitionClosingBraceSpaceSniff.php

class ClassDefinitionClosingBraceSpaceSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS\ClassDefinitionClosingBraceSpaceSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of ClassDefinitionClosingBraceSpaceSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.php, line 18

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS
View source
class ClassDefinitionClosingBraceSpaceSniff implements Sniff {
    
    /**
     * A list of tokenizers this sniff supports.
     *
     * @var array
     */
    public $supportedTokenizers = [
        'CSS',
    ];
    
    /**
     * Returns the token types that this sniff is interested in.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_CLOSE_CURLY_BRACKET,
        ];
    }
    
    //end register()
    
    /**
     * Processes the tokens that this sniff is interested in.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found.
     * @param int                         $stackPtr  The position in the stack where
     *                                               the token was found.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        $next = $stackPtr;
        while (true) {
            $next = $phpcsFile->findNext(T_WHITESPACE, $next + 1, null, true);
            if ($next === false) {
                return;
            }
            if (isset(Tokens::$emptyTokens[$tokens[$next]['code']]) === true && $tokens[$next]['line'] === $tokens[$stackPtr]['line']) {
                // Trailing comment.
                continue;
            }
            break;
        }
        if ($tokens[$next]['code'] !== T_CLOSE_TAG) {
            $found = $tokens[$next]['line'] - $tokens[$stackPtr]['line'] - 1;
            if ($found !== 1) {
                $error = 'Expected one blank line after closing brace of class definition; %s found';
                $data = [
                    max(0, $found),
                ];
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterClose', $data);
                if ($fix === true) {
                    $firstOnLine = $next;
                    while ($tokens[$firstOnLine]['column'] !== 1) {
                        --$firstOnLine;
                    }
                    if ($found < 0) {
                        // Next statement on same line as the closing brace.
                        $phpcsFile->fixer
                            ->addContentBefore($next, $phpcsFile->eolChar . $phpcsFile->eolChar);
                    }
                    else {
                        if ($found === 0) {
                            // Next statement on next line, no blank line.
                            $phpcsFile->fixer
                                ->addContentBefore($firstOnLine, $phpcsFile->eolChar);
                        }
                        else {
                            // Too many blank lines.
                            $phpcsFile->fixer
                                ->beginChangeset();
                            for ($i = $firstOnLine - 1; $i > $stackPtr; $i--) {
                                if ($tokens[$i]['code'] !== T_WHITESPACE) {
                                    break;
                                }
                                $phpcsFile->fixer
                                    ->replaceToken($i, '');
                            }
                            $phpcsFile->fixer
                                ->addContentBefore($firstOnLine, $phpcsFile->eolChar . $phpcsFile->eolChar);
                            $phpcsFile->fixer
                                ->endChangeset();
                        }
                    }
                }
                
                //end if
            }
            
            //end if
        }
        
        //end if
        // Ignore nested style definitions from here on. The spacing before the closing brace
        // (a single blank line) will be enforced by the above check, which ensures there is a
        // blank line after the last nested class.
        $found = $phpcsFile->findPrevious(T_CLOSE_CURLY_BRACKET, $stackPtr - 1, $tokens[$stackPtr]['bracket_opener']);
        if ($found !== false) {
            return;
        }
        $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, $stackPtr - 1, null, true);
        if ($prev === false) {
            return;
        }
        if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
            $error = 'Closing brace of class definition must be on new line';
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContentBeforeClose');
            if ($fix === true) {
                $phpcsFile->fixer
                    ->addNewlineBefore($stackPtr);
            }
        }
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ClassDefinitionClosingBraceSpaceSniff::$supportedTokenizers public property A list of tokenizers this sniff supports.
ClassDefinitionClosingBraceSpaceSniff::process public function Processes the tokens that this sniff is interested in. Overrides Sniff::process
ClassDefinitionClosingBraceSpaceSniff::register public function Returns the token types that this sniff is interested in. Overrides Sniff::register
RSS feed
Powered by Drupal