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

Breadcrumb

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

function ValidClassNameSniff::process

Same name in this branch
  1. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/Classes/ValidClassNameSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes\ValidClassNameSniff::process()
  2. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Sniffs/NamingConventions/ValidClassNameSniff.php \PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions\ValidClassNameSniff::process()

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

Overrides Sniff::process

File

vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/NamingConventions/ValidClassNameSniff.php, line 53

Class

ValidClassNameSniff
\Drupal\Sniffs\NamingConventions\ValidClassNameSniff.

Namespace

Drupal\Sniffs\NamingConventions

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    $className = $phpcsFile->findNext(T_STRING, $stackPtr);
    $name = trim($tokens[$className]['content']);
    $errorData = [
        ucfirst($tokens[$stackPtr]['content']),
    ];
    // Make sure the first letter is a capital.
    if (preg_match('|^[A-Z]|', $name) === 0) {
        $error = '%s name must begin with a capital letter';
        $phpcsFile->addError($error, $stackPtr, 'StartWithCapital', $errorData);
    }
    // Search for underscores.
    if (strpos($name, '_') !== false) {
        $error = '%s name must use UpperCamel naming without underscores';
        $phpcsFile->addError($error, $stackPtr, 'NoUnderscores', $errorData);
    }
}
RSS feed
Powered by Drupal