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

Breadcrumb

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

class OpenBracketSpacingSniff

Checks that there is no white space after an opening bracket, for "(" and "{". Square Brackets are handled by \PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays\ArrayBracketSpacingSniff.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

  • class \Drupal\Sniffs\WhiteSpace\OpenBracketSpacingSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of OpenBracketSpacingSniff

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php, line 24

Namespace

Drupal\Sniffs\WhiteSpace
View source
class OpenBracketSpacingSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_OPEN_CURLY_BRACKET,
            T_OPEN_PARENTHESIS,
            T_OPEN_SHORT_ARRAY,
        ];
    }
    
    //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();
        // Ignore curly brackets in javascript files.
        if ($tokens[$stackPtr]['code'] === T_OPEN_CURLY_BRACKET && $phpcsFile->tokenizerType === 'JS') {
            return;
        }
        if (isset($tokens[$stackPtr + 1]) === true && $tokens[$stackPtr + 1]['code'] === T_WHITESPACE && strpos($tokens[$stackPtr + 1]['content'], $phpcsFile->eolChar) === false && isset($tokens[$stackPtr + 2]) === true && $tokens[$stackPtr + 2]['code'] !== T_CLOSE_TAG) {
            $error = 'There should be no white space after an opening "%s"';
            $fix = $phpcsFile->addFixableError($error, $stackPtr + 1, 'OpeningWhitespace', [
                $tokens[$stackPtr]['content'],
            ]);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($stackPtr + 1, '');
            }
        }
    }
    
    //end process()

}

Members

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