function AbstractClassNamePrefixSniff::process

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

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

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

Return value

void

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/NamingConventions/AbstractClassNamePrefixSniff.php, line 39

Class

AbstractClassNamePrefixSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions

Code

public function process(File $phpcsFile, $stackPtr) {
    if ($phpcsFile->getClassProperties($stackPtr)['is_abstract'] === false) {
        // This class is not abstract so we don't need to check it.
        return;
    }
    $className = $phpcsFile->getDeclarationName($stackPtr);
    if ($className === null) {
        // Live coding or parse error.
        return;
    }
    $prefix = substr($className, 0, 8);
    if (strtolower($prefix) !== 'abstract') {
        $phpcsFile->addError('Abstract class names must be prefixed with "Abstract"; found "%s"', $stackPtr, 'Missing', [
            $className,
        ]);
    }
}