public function CheckPlainSniff::processFunctionCall in Coder 8.3.x

Same name and namespace in other branches

1. 8.3 coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/CheckPlainSniff.php \DrupalPractice\Sniffs\FunctionCalls\CheckPlainSniff::processFunctionCall()
2. 8.2 coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/CheckPlainSniff.php \DrupalPractice\Sniffs\FunctionCalls\CheckPlainSniff::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/CheckPlainSniff.php, line 51

Class

CheckPlainSniff

Check that check_plain() is not used on literal strings.

Namespace

DrupalPractice\Sniffs\FunctionCalls

Code

public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
  $tokens = $phpcsFile
    ->getTokens();
  $argument = $this
    ->getArgument(1);
  if ($argument['start'] === $argument['end'] && $tokens[$argument['start']]['code'] === T_CONSTANT_ENCAPSED_STRING) {
    $warning = 'Do not use check_plain() on string literals, because they cannot contain user provided text';
    $phpcsFile
      ->addWarning($warning, $argument['start'], 'CheckPlainLiteral');
  }
}