public function UnnecessaryStringConcatSniff::process in Coder 8.3

Same name and namespace in other branches

1. 8.2 coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php \Drupal\Sniffs\Strings\UnnecessaryStringConcatSniff::process()
2. 8.3.x 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

File

coder_sniffer/Drupal/Sniffs/Strings/UnnecessaryStringConcatSniff.php, line 43

Class

UnnecessaryStringConcatSniff

Checks that two strings are not concatenated together; suggests using one string instead.

Namespace

Drupal\Sniffs\Strings

Code

public function process(File $phpcsFile, $stackPtr) {

  // Work out which type of file this is for.
  $tokens = $phpcsFile
    ->getTokens();
  if ($tokens[$stackPtr]['code'] === T_STRING_CONCAT) {
    if ($phpcsFile->tokenizerType === 'JS') {
      return;
    }
  }
  else {
    if ($phpcsFile->tokenizerType === 'PHP') {
      return;
    }
  }
  $prev = $phpcsFile
    ->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
  $next = $phpcsFile
    ->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
  if ($prev === false || $next === false) {
    return;
  }
  $stringTokens = Tokens::$stringTokens;
  if (in_array($tokens[$prev]['code'], $stringTokens) === true && in_array($tokens[$next]['code'], $stringTokens) === true) {
    if ($tokens[$prev]['content'][0] === $tokens[$next]['content'][0]) {

      // 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;
        }
      }

      // Before we throw an error check if the string is longer than
      // the line length limit.
      $lineLengthLimitSniff = new LineLengthSniff();
      $lineLenght = $lineLengthLimitSniff
        ->getLineLength($phpcsFile, $tokens[$prev]['line']);
      $stringLength = $lineLenght + strlen($tokens[$next]['content']) - 4;
      if ($stringLength > $lineLengthLimitSniff->lineLimit) {
        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');
      }
    }

    //end if
  }

  //end if
}