CheckPlainSniff.php in Coder 8.3

Namespace

DrupalPractice\Sniffs\FunctionCalls

File

coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/CheckPlainSniff.php

<?php

/**
 * \DrupalPractice\Sniffs\FunctionCalls\CheckPlainSniff
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace DrupalPractice\Sniffs\FunctionCalls;

use PHP_CodeSniffer\Files\File;
use Drupal\Sniffs\Semantics\FunctionCall;

/**
 * Check that check_plain() is not used on literal strings.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class CheckPlainSniff extends FunctionCall {

  /**
   * Returns an array of function names this test wants to listen for.
   *
   * @return array<string>
   */
  public function registerFunctionNames() {
    return [
      'check_plain',
    ];
  }

  //end registerFunctionNames()

  /**
   * Processes this function call.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
   * @param int                         $stackPtr     The position of the function call in
   *                                                  the stack.
   * @param int                         $openBracket  The position of the opening
   *                                                  parenthesis in the stack.
   * @param int                         $closeBracket The position of the closing
   *                                                  parenthesis in the stack.
   *
   * @return void
   */
  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');
    }
  }

}

//end class

Classes

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