You are here

class FormErrorTSniff in Coder 8.3

Same name and namespace in other branches
  1. 8.2 coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php \DrupalPractice\Sniffs\FunctionCalls\FormErrorTSniff
  2. 8.3.x coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php \DrupalPractice\Sniffs\FunctionCalls\FormErrorTSniff

Verifiies that messages passed to form_set_error() run through t().

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

  • class \Drupal\Sniffs\Semantics\FunctionCall implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of FormErrorTSniff

File

coder_sniffer/DrupalPractice/Sniffs/FunctionCalls/FormErrorTSniff.php, line 22

Namespace

DrupalPractice\Sniffs\FunctionCalls
View source
class FormErrorTSniff extends FunctionCall {

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

  //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(2);
    if ($argument !== false && $tokens[$argument['start']]['code'] === T_CONSTANT_ENCAPSED_STRING) {
      $warning = 'Form error messages are user facing text and must run through t() for translation';
      $phpcsFile
        ->addWarning($warning, $argument['start'], 'ErrorMessage');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FormErrorTSniff::processFunctionCall public function Processes this function call.
FormErrorTSniff::registerFunctionNames public function Returns an array of function names this test wants to listen for.
FunctionCall::$arguments protected property Internal cache to save the calculated arguments of the function call.
FunctionCall::$closeBracket protected property The token position of the closing bracket of the function call.
FunctionCall::$functionCall protected property The token position of the function call.
FunctionCall::$includeMethodCalls protected property Whether method invocations with the same function name should be processed, too. 1
FunctionCall::$openBracket protected property The token position of the opening bracket of the function call.
FunctionCall::$phpcsFile protected property The currently processed file.
FunctionCall::getArgument public function Returns start and end token for a given argument number.
FunctionCall::isFunctionCall protected function Checks if this is a function call.
FunctionCall::process public function Processes this test, when one of its tokens is encountered. 2
FunctionCall::register public function Returns an array of tokens this test wants to listen for.