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

Breadcrumb

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

class RequireAbstractOrFinalSniff

Hierarchy

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

Expanded class hierarchy of RequireAbstractOrFinalSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php, line 14

Namespace

SlevomatCodingStandard\Sniffs\Classes
View source
class RequireAbstractOrFinalSniff implements Sniff {
    public const CODE_NO_ABSTRACT_OR_FINAL = 'ClassNeitherAbstractNorFinal';
    
    /**
     * @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 {
        $tokens = $phpcsFile->getTokens();
        $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $classPointer - 1);
        if ($tokens[$previousPointer]['code'] === T_READONLY) {
            $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1);
        }
        if (in_array($tokens[$previousPointer]['code'], [
            T_ABSTRACT,
            T_FINAL,
        ], true)) {
            return;
        }
        $fix = $phpcsFile->addFixableError('All classes should be declared using either the "abstract" or "final" keyword.', $classPointer, self::CODE_NO_ABSTRACT_OR_FINAL);
        if (!$fix) {
            return;
        }
        $phpcsFile->fixer
            ->beginChangeset();
        $phpcsFile->fixer
            ->addContentBefore($classPointer, 'final ');
        $phpcsFile->fixer
            ->endChangeset();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
RequireAbstractOrFinalSniff::CODE_NO_ABSTRACT_OR_FINAL public constant
RequireAbstractOrFinalSniff::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides Sniff::process
RequireAbstractOrFinalSniff::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