public function TCheckPlainSniff::processFunctionCall in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/TCheckPlainSniff.php \DrupalPractice\Sniffs\FunctionCalls\TCheckPlainSniff::processFunctionCall()
2. 8.3.x coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/TCheckPlainSniff.php \DrupalPractice\Sniffs\FunctionCalls\TCheckPlainSniff::processFunctionCall()

Processes this function call.

Parameters

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

int $stackPtr The position of the function call in: the stack.

int $openBracket The position of the opening: parenthesis in the stack.

int $closeBracket The position of the closing: parenthesis in the stack.

Return value

void

File

coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/TCheckPlainSniff.php, line 55

Class

TCheckPlainSniff

Check that "@" and "%" placeholders in t()/watchdog() are not escaped twice with check_plain().

Namespace

DrupalPractice\Sniffs\FunctionCalls

Code

public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
  $tokens = $phpcsFile
    ->getTokens();
  if ($tokens[$stackPtr]['content'] === 't') {
    $argument = $this
      ->getArgument(2);
  }
  else {

    // For watchdog() the placeholders are in the third argument.
    $argument = $this
      ->getArgument(3);
  }
  if ($argument === false) {
    return;
  }
  if ($tokens[$argument['start']]['code'] !== T_ARRAY) {
    return;
  }
  $checkPlain = $argument['start'];
  while (($checkPlain = $phpcsFile
    ->findNext(T_STRING, $checkPlain + 1, $tokens[$argument['start']]['parenthesis_closer'])) !== false) {
    if ($tokens[$checkPlain]['content'] === 'check_plain') {

      // The check_plain() could be embedded with string concatenation,
      // which we want to allow.
      $previous = $phpcsFile
        ->findPrevious(T_WHITESPACE, $checkPlain - 1, $argument['start'], true);
      if ($previous === false || $tokens[$previous]['code'] !== T_STRING_CONCAT) {
        $warning = 'The extra check_plain() is not necessary for placeholders, "@" and "%" will automatically run check_plain()';
        $phpcsFile
          ->addWarning($warning, $checkPlain, 'CheckPlain');
      }
    }
  }
}