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

Breadcrumb

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

function IncrementDecrementSpacingSniff::process

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

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

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/Generic/Sniffs/WhiteSpace/IncrementDecrementSpacingSniff.php, line 54

Class

IncrementDecrementSpacingSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $tokenName = 'increment';
    if ($tokens[$stackPtr]['code'] === T_DEC) {
        $tokenName = 'decrement';
    }
    // Is this a pre-increment/decrement ?
    $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
    if ($nextNonEmpty !== false && ($phpcsFile->tokenizerType === 'PHP' && ($tokens[$nextNonEmpty]['code'] === T_VARIABLE || $tokens[$nextNonEmpty]['code'] === T_STRING) || $phpcsFile->tokenizerType === 'JS' && $tokens[$nextNonEmpty]['code'] === T_STRING)) {
        if ($nextNonEmpty === $stackPtr + 1) {
            $phpcsFile->recordMetric($stackPtr, 'Spacing between in/decrementor and variable', 0);
            return;
        }
        $spaces = 0;
        $fixable = true;
        $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
        if ($nextNonWhitespace !== $nextNonEmpty) {
            $fixable = false;
            $spaces = 'comment';
        }
        else {
            if ($tokens[$stackPtr]['line'] !== $tokens[$nextNonEmpty]['line']) {
                $spaces = 'newline';
            }
            else {
                $spaces = $tokens[$stackPtr + 1]['length'];
            }
        }
        $phpcsFile->recordMetric($stackPtr, 'Spacing between in/decrementor and variable', $spaces);
        $error = 'Expected no spaces between the %s operator and %s; %s found';
        $errorCode = 'SpaceAfter' . ucfirst($tokenName);
        $data = [
            $tokenName,
            $tokens[$nextNonEmpty]['content'],
            $spaces,
        ];
        if ($fixable === false) {
            $phpcsFile->addError($error, $stackPtr, $errorCode, $data);
            return;
        }
        $fix = $phpcsFile->addFixableError($error, $stackPtr, $errorCode, $data);
        if ($fix === true) {
            $phpcsFile->fixer
                ->beginChangeset();
            for ($i = $stackPtr + 1; $i < $nextNonEmpty; $i++) {
                $phpcsFile->fixer
                    ->replaceToken($i, '');
            }
            $phpcsFile->fixer
                ->endChangeset();
        }
        return;
    }
    
    //end if
    // Is this a post-increment/decrement ?
    $prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, $stackPtr - 1, null, true);
    if ($prevNonEmpty !== false && ($phpcsFile->tokenizerType === 'PHP' && ($tokens[$prevNonEmpty]['code'] === T_VARIABLE || $tokens[$prevNonEmpty]['code'] === T_STRING || $tokens[$prevNonEmpty]['code'] === T_CLOSE_SQUARE_BRACKET) || $phpcsFile->tokenizerType === 'JS' && $tokens[$prevNonEmpty]['code'] === T_STRING)) {
        if ($prevNonEmpty === $stackPtr - 1) {
            $phpcsFile->recordMetric($stackPtr, 'Spacing between in/decrementor and variable', 0);
            return;
        }
        $spaces = 0;
        $fixable = true;
        $prevNonWhitespace = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
        if ($prevNonWhitespace !== $prevNonEmpty) {
            $fixable = false;
            $spaces = 'comment';
        }
        else {
            if ($tokens[$stackPtr]['line'] !== $tokens[$prevNonEmpty]['line']) {
                $spaces = 'newline';
            }
            else {
                $spaces = $tokens[$stackPtr - 1]['length'];
            }
        }
        $phpcsFile->recordMetric($stackPtr, 'Spacing between in/decrementor and variable', $spaces);
        $error = 'Expected no spaces between %s and the %s operator; %s found';
        $errorCode = 'SpaceAfter' . ucfirst($tokenName);
        $data = [
            $tokens[$prevNonEmpty]['content'],
            $tokenName,
            $spaces,
        ];
        if ($fixable === false) {
            $phpcsFile->addError($error, $stackPtr, $errorCode, $data);
            return;
        }
        $fix = $phpcsFile->addFixableError($error, $stackPtr, $errorCode, $data);
        if ($fix === true) {
            $phpcsFile->fixer
                ->beginChangeset();
            for ($i = $stackPtr - 1; $prevNonEmpty < $i; $i--) {
                $phpcsFile->fixer
                    ->replaceToken($i, '');
            }
            $phpcsFile->fixer
                ->endChangeset();
        }
    }
    
    //end if
}

API Navigation

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