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

Breadcrumb

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

class ColourDefinitionSniff

Same name in this branch
  1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/CSS/ColourDefinitionSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS\ColourDefinitionSniff

\Drupal\Sniffs\CSS\ColourDefinitionSniff.

Ensure colors are defined in lower-case.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

  • class \Drupal\Sniffs\CSS\ColourDefinitionSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of ColourDefinitionSniff

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/CSS/ColourDefinitionSniff.php, line 24

Namespace

Drupal\Sniffs\CSS
View source
class ColourDefinitionSniff implements Sniff {
    
    /**
     * A list of tokenizers this sniff supports.
     *
     * @var array<string>
     */
    public $supportedTokenizers = [
        'CSS',
    ];
    
    /**
     * Returns the token types that this sniff is interested in.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_COLOUR,
        ];
    }
    
    //end 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
     *                                               the token was found.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        $color = $tokens[$stackPtr]['content'];
        $expected = strtolower($color);
        if ($color !== $expected) {
            $error = 'CSS colors must be defined in lowercase; expected %s but found %s';
            $data = [
                $expected,
                $color,
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotLower', $data);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($stackPtr, $expected);
            }
        }
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ColourDefinitionSniff::$supportedTokenizers public property A list of tokenizers this sniff supports.
ColourDefinitionSniff::process public function Processes the tokens that this sniff is interested in. Overrides Sniff::process
ColourDefinitionSniff::register public function Returns the token types that this sniff is interested in. Overrides Sniff::register
RSS feed
Powered by Drupal