ClassNamingSniff Class Reference

Inheritance diagram for ClassNamingSniff:

Public Member Functions
	register ()
	process (File $phpcsFile, $stackPtr)

Data Fields
const	STRING_HELPER_CLASSES_PREFIX = '_'
const	STRING_ALLOWED_UNDERSCORES = '__'
	$supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS]

Detailed Description

Class ClassNamingSniff

Ensure that class name responds to the following requirements:

• names should be lowercase;
• start with a letter (except helper classes);
• words should be separated with dash '-';

http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-less.html#standard-classes

Definition at line 23 of file ClassNamingSniff.php.

Member Function Documentation

process()

process	(	File	$phpcsFile,
			$stackPtr
	)

{}

Definition at line 48 of file ClassNamingSniff.php.

    {
        $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);
        }
    }

register()

register

(

)

{}

Definition at line 40 of file ClassNamingSniff.php.

    {
        return [T_STRING_CONCAT];
    }

Field Documentation

$supportedTokenizers

$supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS]

Definition at line 35 of file ClassNamingSniff.php.

STRING_ALLOWED_UNDERSCORES

const STRING_ALLOWED_UNDERSCORES = '__'

Definition at line 28 of file ClassNamingSniff.php.

STRING_HELPER_CLASSES_PREFIX

const STRING_HELPER_CLASSES_PREFIX = '_'

Definition at line 26 of file ClassNamingSniff.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/static/framework/Magento/Sniffs/Less/ClassNamingSniff.php