TCheckPlainSniff.php in Coder 8.3.x

Namespace

DrupalPractice\Sniffs\FunctionCalls

File

coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/TCheckPlainSniff.php

<?php

/**
 * \DrupalPractice\Sniffs\FunctionCalls\TCheckPlainSniff
 *
 * @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 "@" and "%" placeholders in t()/watchdog() are not escaped twice
 * with check_plain().
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class TCheckPlainSniff extends FunctionCall {

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

  //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();
    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');
        }
      }
    }
  }

}

//end class

Classes

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