function UnnecessaryStringConcatSniff::process

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php \Drupal\Sniffs\Strings\UnnecessaryStringConcatSniff::process()

Processes this sniff, 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

1 method overrides UnnecessaryStringConcatSniff::process()

UnnecessaryStringConcatSniff::process in vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php

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

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Strings/UnnecessaryStringConcatSniff.php, line 71

Class

UnnecessaryStringConcatSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Strings

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    if ($tokens[$stackPtr]['code'] === T_STRING_CONCAT && $phpcsFile->tokenizerType === 'JS') {
        // JS uses T_PLUS for string concatenation, not T_STRING_CONCAT.
        return;
    }
    else {
        if ($tokens[$stackPtr]['code'] === T_PLUS && $phpcsFile->tokenizerType === 'PHP') {
            // PHP uses T_STRING_CONCAT for string concatenation, not T_PLUS.
            return;
        }
    }
    $prev = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
    $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
    if ($next === false) {
        return;
    }
    if (isset(Tokens::$stringTokens[$tokens[$prev]['code']]) === false || isset(Tokens::$stringTokens[$tokens[$next]['code']]) === false) {
        // Bow out as at least one of the two tokens being concatenated is not a string.
        return;
    }
    if ($tokens[$prev]['content'][0] !== $tokens[$next]['content'][0]) {
        // Bow out as the two strings are not of the same type.
        return;
    }
    // Before we throw an error for PHP, allow strings to be
    // combined if they would have < and ? next to each other because
    // this trick is sometimes required in PHP strings.
    if ($phpcsFile->tokenizerType === 'PHP') {
        $prevChar = substr($tokens[$prev]['content'], -2, 1);
        $nextChar = $tokens[$next]['content'][1];
        $combined = $prevChar . $nextChar;
        if ($combined === '?' . '>' || $combined === '<' . '?') {
            return;
        }
    }
    if ($this->allowMultiline === true && $tokens[$prev]['line'] !== $tokens[$next]['line']) {
        return;
    }
    $error = 'String concat is not required here; use a single string instead';
    if ($this->error === true) {
        $phpcsFile->addError($error, $stackPtr, 'Found');
    }
    else {
        $phpcsFile->addWarning($error, $stackPtr, 'Found');
    }
}