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

Breadcrumb

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

class ArrayBracketSpacingSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays\ArrayBracketSpacingSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of ArrayBracketSpacingSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Arrays/ArrayBracketSpacingSniff.php, line 15

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays
View source
class ArrayBracketSpacingSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_OPEN_SQUARE_BRACKET,
            T_CLOSE_SQUARE_BRACKET,
        ];
    }
    
    //end register()
    
    /**
     * Processes this sniff, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being checked.
     * @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 ($tokens[$stackPtr]['code'] === T_OPEN_SQUARE_BRACKET && isset($tokens[$stackPtr]['bracket_closer']) === false || $tokens[$stackPtr]['code'] === T_CLOSE_SQUARE_BRACKET && isset($tokens[$stackPtr]['bracket_opener']) === false) {
            // Bow out for parse error/during live coding.
            return;
        }
        // Square brackets can not have a space before them.
        $prevType = $tokens[$stackPtr - 1]['code'];
        if ($prevType === T_WHITESPACE) {
            $nonSpace = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 2, null, true);
            $expected = $tokens[$nonSpace]['content'] . $tokens[$stackPtr]['content'];
            $found = $phpcsFile->getTokensAsString($nonSpace, $stackPtr - $nonSpace) . $tokens[$stackPtr]['content'];
            $error = 'Space found before square bracket; expected "%s" but found "%s"';
            $data = [
                $expected,
                $found,
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeBracket', $data);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($stackPtr - 1, '');
            }
        }
        // Open square brackets can't ever have spaces after them.
        if ($tokens[$stackPtr]['code'] === T_OPEN_SQUARE_BRACKET) {
            $nextType = $tokens[$stackPtr + 1]['code'];
            if ($nextType === T_WHITESPACE) {
                $nonSpace = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 2, null, true);
                $expected = $tokens[$stackPtr]['content'] . $tokens[$nonSpace]['content'];
                $found = $phpcsFile->getTokensAsString($stackPtr, $nonSpace - $stackPtr + 1);
                $error = 'Space found after square bracket; expected "%s" but found "%s"';
                $data = [
                    $expected,
                    $found,
                ];
                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterBracket', $data);
                if ($fix === true) {
                    $phpcsFile->fixer
                        ->replaceToken($stackPtr + 1, '');
                }
            }
        }
    }
    
    //end process()

}

Members

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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal