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

Breadcrumb

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

function ArrayBracketSpacingSniff::process

Processes this sniff, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The current file being checked.:

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

Return value

void

Overrides Sniff::process

File

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

Class

ArrayBracketSpacingSniff

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays

Code

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, '');
            }
        }
    }
}

API Navigation

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