Mercurial > hg > isophonics-drupal-site
view vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/WhiteSpace/EmptyLinesSniff.php @ 17:129ea1e6d783
Update, including to Drupal core 8.6.10
author | Chris Cannam |
---|---|
date | Thu, 28 Feb 2019 13:21:36 +0000 |
parents | 4c8ae668cc8c |
children |
line wrap: on
line source
<?php /** * \Drupal\Sniffs\WhiteSpace\EmptyLinesSniff. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ namespace Drupal\Sniffs\WhiteSpace; use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Sniffs\Sniff; /** * \Drupal\Sniffs\WhiteSpace\EmptyLinesSniff. * * Checks that there are not more than 2 empty lines following each other. * * @category PHP * @package PHP_CodeSniffer * @link http://pear.php.net/package/PHP_CodeSniffer */ class EmptyLinesSniff implements Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', 'CSS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_WHITESPACE); }//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) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['content'] === $phpcsFile->eolChar && isset($tokens[($stackPtr + 1)]) === true && $tokens[($stackPtr + 1)]['content'] === $phpcsFile->eolChar && isset($tokens[($stackPtr + 2)]) === true && $tokens[($stackPtr + 2)]['content'] === $phpcsFile->eolChar && isset($tokens[($stackPtr + 3)]) === true && $tokens[($stackPtr + 3)]['content'] === $phpcsFile->eolChar ) { $error = 'More than 2 empty lines are not allowed'; $phpcsFile->addError($error, ($stackPtr + 3), 'EmptyLines'); } }//end process() }//end class