ClassNamingSniff.php

Go to the documentation of this file.

<?php
namespace Magento\Sniffs\Less;

use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;

class ClassNamingSniff implements Sniff
{

    const STRING_HELPER_CLASSES_PREFIX = '_';

    const STRING_ALLOWED_UNDERSCORES = '__';

    public $supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS];

    public function register()
    {
        return [T_STRING_CONCAT];
    }

    public function process(File $phpcsFile, $stackPtr)
    {
        $tokens = $phpcsFile->getTokens();

        if (T_WHITESPACE !== $tokens[$stackPtr - 1]['code']
            && !in_array($tokens[$stackPtr - 1]['content'], [
                TokenizerSymbolsInterface::INDENT_SPACES,
                TokenizerSymbolsInterface::NEW_LINE,
            ])
        ) {
            return;
        }

        $className = $tokens[$stackPtr + 1]['content'];
        if (preg_match_all('/[^a-z0-9\-_]/U', $className, $matches)) {
            $phpcsFile->addError('Class name contains not allowed symbols', $stackPtr, 'NotAllowedSymbol', $matches);
        }
    }
}