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

Breadcrumb

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

class DebugCodeSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\MySource\Sniffs\Debug\DebugCodeSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of DebugCodeSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/MySource/Sniffs/Debug/DebugCodeSniff.php, line 17

Namespace

PHP_CodeSniffer\Standards\MySource\Sniffs\Debug
View source
class DebugCodeSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_DOUBLE_COLON,
        ];
    }
    
    //end register()
    
    /**
     * Processes this sniff, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token in
     *                                               the stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        $className = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
        if (strtolower($tokens[$className]['content']) === 'debug') {
            $method = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
            $error = 'Call to debug function Debug::%s() must be removed';
            $data = [
                $tokens[$method]['content'],
            ];
            $phpcsFile->addError($error, $stackPtr, 'Found', $data);
        }
    }
    
    //end process()

}

Members

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