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

Breadcrumb

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

function ClassConstantVisibilitySniff::process

* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

Parameters

int $constantPointer:

Overrides Sniff::process

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassConstantVisibilitySniff.php, line 43

Class

ClassConstantVisibilitySniff

Namespace

SlevomatCodingStandard\Sniffs\Classes

Code

public function process(File $phpcsFile, $constantPointer) : void {
    $tokens = $phpcsFile->getTokens();
    if (count($tokens[$constantPointer]['conditions']) === 0) {
        return;
    }
    
    /** @var int $classPointer */
    $classPointer = array_keys($tokens[$constantPointer]['conditions'])[count($tokens[$constantPointer]['conditions']) - 1];
    if (!in_array($tokens[$classPointer]['code'], Tokens::$ooScopeTokens, true)) {
        return;
    }
    $visibilityPointer = TokenHelper::findPreviousEffective($phpcsFile, $constantPointer - 1);
    if ($tokens[$visibilityPointer]['code'] === T_FINAL) {
        $visibilityPointer = TokenHelper::findPreviousEffective($phpcsFile, $visibilityPointer - 1);
    }
    if (in_array($tokens[$visibilityPointer]['code'], [
        T_PUBLIC,
        T_PROTECTED,
        T_PRIVATE,
    ], true)) {
        return;
    }
    $equalSignPointer = TokenHelper::findNext($phpcsFile, T_EQUAL, $constantPointer + 1);
    $namePointer = TokenHelper::findPreviousEffective($phpcsFile, $equalSignPointer - 1);
    $message = sprintf('Constant %s::%s visibility missing.', ClassHelper::getFullyQualifiedName($phpcsFile, $classPointer), $tokens[$namePointer]['content']);
    if ($this->fixable) {
        $fix = $phpcsFile->addFixableError($message, $constantPointer, self::CODE_MISSING_CONSTANT_VISIBILITY);
        if ($fix) {
            $phpcsFile->fixer
                ->beginChangeset();
            $phpcsFile->fixer
                ->addContentBefore($constantPointer, 'public ');
            $phpcsFile->fixer
                ->endChangeset();
        }
    }
    else {
        $phpcsFile->addError($message, $constantPointer, self::CODE_MISSING_CONSTANT_VISIBILITY);
    }
}

API Navigation

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