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

Breadcrumb

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

class SuperfluousAbstractClassNamingSniff

Hierarchy

  • class \SlevomatCodingStandard\Sniffs\Classes\SuperfluousAbstractClassNamingSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of SuperfluousAbstractClassNamingSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousAbstractClassNamingSniff.php, line 15

Namespace

SlevomatCodingStandard\Sniffs\Classes
View source
class SuperfluousAbstractClassNamingSniff implements Sniff {
    public const CODE_SUPERFLUOUS_PREFIX = 'SuperfluousPrefix';
    public const CODE_SUPERFLUOUS_SUFFIX = 'SuperfluousSuffix';
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_CLASS,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $classPointer
     */
    public function process(File $phpcsFile, $classPointer) : void {
        $className = ClassHelper::getName($phpcsFile, $classPointer);
        $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $classPointer - 1);
        if ($phpcsFile->getTokens()[$previousPointer]['code'] !== T_ABSTRACT) {
            return;
        }
        $this->checkPrefix($phpcsFile, $classPointer, $className);
        $this->checkSuffix($phpcsFile, $classPointer, $className);
    }
    private function checkPrefix(File $phpcsFile, int $classPointer, string $className) : void {
        $prefix = substr($className, 0, 8);
        if (strtolower($prefix) !== 'abstract') {
            return;
        }
        $phpcsFile->addError(sprintf('Superfluous prefix "%s".', $prefix), $classPointer, self::CODE_SUPERFLUOUS_PREFIX);
    }
    private function checkSuffix(File $phpcsFile, int $classPointer, string $className) : void {
        $suffix = substr($className, -8);
        if (strtolower($suffix) !== 'abstract') {
            return;
        }
        $phpcsFile->addError(sprintf('Superfluous suffix "%s".', $suffix), $classPointer, self::CODE_SUPERFLUOUS_SUFFIX);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
SuperfluousAbstractClassNamingSniff::checkPrefix private function
SuperfluousAbstractClassNamingSniff::checkSuffix private function
SuperfluousAbstractClassNamingSniff::CODE_SUPERFLUOUS_PREFIX public constant
SuperfluousAbstractClassNamingSniff::CODE_SUPERFLUOUS_SUFFIX public constant
SuperfluousAbstractClassNamingSniff::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides Sniff::process
SuperfluousAbstractClassNamingSniff::register public function * Overrides Sniff::register

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal