Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. TInHookSchemaSniff.php

class TInHookSchemaSniff

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

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

Hierarchy

  • class \Drupal\Sniffs\Semantics\FunctionDefinition implements \PHP_CodeSniffer\Sniffs\Sniff
    • class \Drupal\Sniffs\Semantics\TInHookSchemaSniff extends \Drupal\Sniffs\Semantics\FunctionDefinition

Expanded class hierarchy of TInHookSchemaSniff

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Semantics/TInHookSchemaSniff.php, line 22

Namespace

Drupal\Sniffs\Semantics
View source
class TInHookSchemaSniff extends FunctionDefinition {
    
    /**
     * Process this function definition.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile   The file being scanned.
     * @param int                         $stackPtr    The position of the function name in the stack.
     *                                                 name in the stack.
     * @param int                         $functionPtr The position of the function keyword in the stack.
     *                                                 keyword in the stack.
     *
     * @return void
     */
    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
    }
    
    //end processFunction()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
FunctionDefinition::process public function Processes this test, when one of its tokens is encountered. Overrides Sniff::process
FunctionDefinition::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
TInHookSchemaSniff::processFunction public function Process this function definition. Overrides FunctionDefinition::processFunction
RSS feed
Powered by Drupal