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

Breadcrumb

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

class AbstractClassNamePrefixSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\AbstractClassNamePrefixSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of AbstractClassNamePrefixSniff

File

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

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions
View source
class AbstractClassNamePrefixSniff implements Sniff {
    
    /**
     * Registers the tokens that this sniff wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_CLASS,
        ];
    }
    
    //end register()
    
    /**
     * Processes this sniff, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token
     *                                               in the stack passed in $tokens.
     *
     * @return void
     */
    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,
            ]);
        }
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
AbstractClassNamePrefixSniff::process public function Processes this sniff, when one of its tokens is encountered. Overrides Sniff::process
AbstractClassNamePrefixSniff::register public function Registers the tokens that this sniff wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal