public function TInHookSchemaSniff::processFunction in Coder 8.2

Same name and namespace in other branches

1. 8.3 coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php \Drupal\Sniffs\Semantics\TInHookSchemaSniff::processFunction()
2. 8.3.x coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php \Drupal\Sniffs\Semantics\TInHookSchemaSniff::processFunction()

Process this function definition.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the function name in the stack.: name in the stack.

int $functionPtr The position of the function keyword in the stack.: keyword in the stack.

Return value

void

Overrides FunctionDefinition::processFunction

File

coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php, line 38

Class

TInHookSchemaSniff

Checks that t() is not used in hook_schema().

Namespace

Drupal\Sniffs\Semantics

Code

public function processFunction(File $phpcsFile, $stackPtr, $functionPtr) {
  $fileExtension = strtolower(substr($phpcsFile
    ->getFilename(), -7));

  // Only check in *.install files.
  if ($fileExtension !== 'install') {
    return;
  }
  $fileName = substr(basename($phpcsFile
    ->getFilename()), 0, -8);
  $tokens = $phpcsFile
    ->getTokens();
  if ($tokens[$stackPtr]['content'] !== $fileName . '_schema') {
    return;
  }

  // Search in the function body for t() calls.
  $string = $phpcsFile
    ->findNext(T_STRING, $tokens[$functionPtr]['scope_opener'], $tokens[$functionPtr]['scope_closer']);
  while ($string !== false) {
    if ($tokens[$string]['content'] === 't') {
      $opener = $phpcsFile
        ->findNext(Tokens::$emptyTokens, $string + 1, null, true);
      if ($opener !== false && $tokens[$opener]['code'] === T_OPEN_PARENTHESIS) {
        $error = 'Do not use t() in hook_schema(), this will only generate overhead for translators';
        $phpcsFile
          ->addError($error, $string, 'TFound');
      }
    }
    $string = $phpcsFile
      ->findNext(T_STRING, $string + 1, $tokens[$functionPtr]['scope_closer']);
  }

  //end while
}