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

Breadcrumb

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

class BrowserSpecificStylesSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\MySource\Sniffs\CSS\BrowserSpecificStylesSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of BrowserSpecificStylesSniff

File

vendor/squizlabs/php_codesniffer/src/Standards/MySource/Sniffs/CSS/BrowserSpecificStylesSniff.php, line 17

Namespace

PHP_CodeSniffer\Standards\MySource\Sniffs\CSS
View source
class BrowserSpecificStylesSniff implements Sniff {
    
    /**
     * A list of tokenizers this sniff supports.
     *
     * @var array
     */
    public $supportedTokenizers = [
        'CSS',
    ];
    
    /**
     * A list of specific stylesheet suffixes we allow.
     *
     * These stylesheets contain browser specific styles
     * so this sniff ignore them files in the form:
     * *_moz.css and *_ie7.css etc.
     *
     * @var array
     */
    protected $specificStylesheets = [
        'moz' => true,
        'ie' => true,
        'ie7' => true,
        'ie8' => true,
        'webkit' => true,
    ];
    
    /**
     * Returns the token types that this sniff is interested in.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_STYLE,
        ];
    }
    
    //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) {
        // Ignore files with browser-specific suffixes.
        $filename = $phpcsFile->getFilename();
        $breakChar = strrpos($filename, '_');
        if ($breakChar !== false && substr($filename, -4) === '.css') {
            $specific = substr($filename, $breakChar + 1, -4);
            if (isset($this->specificStylesheets[$specific]) === true) {
                return;
            }
        }
        $tokens = $phpcsFile->getTokens();
        $content = $tokens[$stackPtr]['content'];
        if ($content[0] === '-') {
            $error = 'Browser-specific styles are not allowed';
            $phpcsFile->addError($error, $stackPtr, 'ForbiddenStyle');
        }
    }
    
    //end process()

}

Members

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