Source for file ColourDefinitionSniff.php
Documentation is available at ColourDefinitionSniff.php
* Ensure colours are defined in upper-case and use shortcuts where possible.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class ColourDefinitionSniff implements Sniff
* A list of tokenizers this sniff supports.
public $supportedTokenizers = array ('CSS');
* Returns the token types that this sniff is interested in.
public function register ()
* Processes the tokens that this sniff is interested in.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found.
* @param int $stackPtr The position in the stack where
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
$colour = $tokens[$stackPtr]['content'];
if ($colour !== $expected) {
$error = 'CSS colours must be defined in uppercase; expected %s but found %s';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'NotUpper', $data);
$phpcsFile->fixer ->replaceToken ($stackPtr, $expected);
// Now check if shorthand can be used.
if ($colour{1 } === $colour{2 } && $colour{3 } === $colour{4 } && $colour{5 } === $colour{6 }) {
$expected = '#'. $colour{1 }. $colour{3 }. $colour{5 };
$error = 'CSS colours must use shorthand if available; expected %s but found %s';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'Shorthand', $data);
$phpcsFile->fixer ->replaceToken ($stackPtr, $expected);
Documentation generated on Mon, 11 Mar 2019 15:27:18 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|