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

Breadcrumb

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

class ClosingBraceSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\PSR12\Sniffs\Classes\ClosingBraceSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of ClosingBraceSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/PSR12/Sniffs/Classes/ClosingBraceSniff.php, line 15

Namespace

PHP_CodeSniffer\Standards\PSR12\Sniffs\Classes
View source
class ClosingBraceSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_CLASS,
            T_INTERFACE,
            T_TRAIT,
            T_ENUM,
            T_FUNCTION,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token in the
     *                                               stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        if (isset($tokens[$stackPtr]['scope_closer']) === false) {
            return;
        }
        $closer = $tokens[$stackPtr]['scope_closer'];
        $next = $phpcsFile->findNext(T_WHITESPACE, $closer + 1, null, true);
        if ($next === false || $tokens[$next]['line'] !== $tokens[$closer]['line']) {
            return;
        }
        $error = 'Closing brace must not be followed by any comment or statement on the same line';
        $phpcsFile->addError($error, $closer, 'StatementAfter');
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ClosingBraceSniff::process public function Processes this test, when one of its tokens is encountered. Overrides Sniff::process
ClosingBraceSniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal