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

Breadcrumb

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

class HeredocSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP\HeredocSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of HeredocSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/PHP/HeredocSniff.php, line 15

Namespace

PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP
View source
class HeredocSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_START_HEREDOC,
            T_START_NOWDOC,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, 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) {
        $error = 'Use of heredoc and nowdoc syntax ("<<<") is not allowed; use standard strings or inline HTML instead';
        $phpcsFile->addError($error, $stackPtr, 'NotAllowed');
    }
    
    //end process()

}

Members

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