class Drupal_Sniffs_Semantics_FunctionWatchdogSniff in Coder 7.2

Checks that the second argument to watchdog() is not enclosed with t().

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

Hierarchy

• class \Drupal_Sniffs_Semantics_FunctionCall implements \PHP_CodeSniffer_Sniff
  • class \Drupal_Sniffs_Semantics_FunctionWatchdogSniff

File

coder_sniffer/Drupal/Sniffs/Semantics/FunctionWatchdogSniff.php, line 19

class Drupal_Sniffs_Semantics_FunctionWatchdogSniff extends Drupal_Sniffs_Semantics_FunctionCall {

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

  //end registerFunctionNames()

  /**
   * Processes this function call.
   *
   * @param PHP_CodeSniffer_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.
   * @param Drupal_Sniffs_Semantics_FunctionCallSniff $sniff
   *   Can be used to retreive the function's arguments with the getArgument()
   *   method.
   *
   * @return void
   */
  public function processFunctionCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $closeBracket, Drupal_Sniffs_Semantics_FunctionCallSniff $sniff) {
    $tokens = $phpcsFile
      ->getTokens();

    // Get the second argument passed to watchdog().
    $argument = $sniff
      ->getArgument(2);
    if ($argument === false) {
      $error = 'The second argument to watchdog() is missing';
      $phpcsFile
        ->addError($error, $stackPtr, 'WatchdogArgument');
      return;
    }
    if ($tokens[$argument['start']]['code'] === T_STRING && $tokens[$argument['start']]['content'] === 't') {
      $error = 'The second argument to watchdog() should not be enclosed with t()';
      $phpcsFile
        ->addError($error, $argument['start'], 'WatchdogT');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Drupal_Sniffs_Semantics_FunctionCall::process	public	function	Processes this test, when one of its tokens is encountered.
Drupal_Sniffs_Semantics_FunctionCall::register	public	function	Returns an array of tokens this test wants to listen for.
Drupal_Sniffs_Semantics_FunctionWatchdogSniff::processFunctionCall	public	function	Processes this function call. Overrides Drupal_Sniffs_Semantics_FunctionCall::processFunctionCall
Drupal_Sniffs_Semantics_FunctionWatchdogSniff::registerFunctionNames	public	function	Returns an array of function names this test wants to listen for.