function InstallTSniff::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.

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

Return value

void|int

Overrides FunctionDefinition::processFunction

File

vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/FunctionDefinitions/InstallTSniff.php, line 39

Class

InstallTSniff

Checks that t() and st() are not used in hook_install() and hook_requirements().

Namespace

DrupalPractice\Sniffs\FunctionDefinitions

Code

public function processFunction(File $phpcsFile, $stackPtr, $functionPtr) {
    $fileExtension = strtolower(substr($phpcsFile->getFilename(), -7));
    // Only check in *.install files.
    if ($fileExtension !== 'install') {
        return $phpcsFile->numTokens + 1;
    }
    $fileName = substr(basename($phpcsFile->getFilename()), 0, -8);
    $tokens = $phpcsFile->getTokens();
    if ($tokens[$stackPtr]['content'] !== $fileName . '_install' && $tokens[$stackPtr]['content'] !== $fileName . '_requirements') {
        return;
    }
    // This check only applies to Drupal 7, not Drupal 8.
    if (Project::getCoreVersion($phpcsFile) !== 7) {
        return $phpcsFile->numTokens + 1;
    }
    // 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' || $tokens[$string]['content'] === 'st') {
            $opener = $phpcsFile->findNext(Tokens::$emptyTokens, $string + 1, null, true);
            if ($opener !== false && $tokens[$opener]['code'] === T_OPEN_PARENTHESIS) {
                $error = 'Do not use t() or st() in installation phase hooks, use $t = get_t() to retrieve the appropriate localization function name';
                $phpcsFile->addError($error, $string, 'TranslationFound');
            }
        }
        $string = $phpcsFile->findNext(T_STRING, $string + 1, $tokens[$functionPtr]['scope_closer']);
    }
    
    //end while
}