Chris@0: <?php
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\CSS\ColourDefinitionSniff.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@17: namespace Drupal\Sniffs\CSS;
Chris@17: 
Chris@17: use PHP_CodeSniffer\Files\File;
Chris@17: use PHP_CodeSniffer\Sniffs\Sniff;
Chris@17: 
Chris@0: /**
Chris@17:  * \Drupal\Sniffs\CSS\ColourDefinitionSniff.
Chris@0:  *
Chris@0:  * Ensure colours are defined in lower-case.
Chris@0:  *
Chris@0:  * @category PHP
Chris@0:  * @package  PHP_CodeSniffer
Chris@0:  * @link     http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@17: class ColourDefinitionSniff implements Sniff
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * A list of tokenizers this sniff supports.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public $supportedTokenizers = array('CSS');
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the token types that this sniff is interested in.
Chris@0:      *
Chris@0:      * @return array(int)
Chris@0:      */
Chris@0:     public function register()
Chris@0:     {
Chris@0:         return array(T_COLOUR);
Chris@0: 
Chris@0:     }//end register()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Processes the tokens that this sniff is interested in.
Chris@0:      *
Chris@17:      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found.
Chris@17:      * @param int                         $stackPtr  The position in the stack where
Chris@17:      *                                               the token was found.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@17:     public function process(File $phpcsFile, $stackPtr)
Chris@0:     {
Chris@0:         $tokens = $phpcsFile->getTokens();
Chris@0:         $colour = $tokens[$stackPtr]['content'];
Chris@0: 
Chris@0:         $expected = strtolower($colour);
Chris@0:         if ($colour !== $expected) {
Chris@0:             $error = 'CSS colours must be defined in lowercase; expected %s but found %s';
Chris@0:             $data  = array(
Chris@0:                       $expected,
Chris@0:                       $colour,
Chris@0:                      );
Chris@0:             $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NotLower', $data);
Chris@0:             if ($fix === true) {
Chris@0:                 $phpcsFile->fixer->replaceToken($stackPtr, $expected);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:     }//end process()
Chris@0: 
Chris@0: 
Chris@0: }//end class