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

Breadcrumb

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

function RequireSelfReferenceSniff::process

* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

Parameters

int $openTagPointer:

Overrides Sniff::process

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSelfReferenceSniff.php, line 38

Class

RequireSelfReferenceSniff

Namespace

SlevomatCodingStandard\Sniffs\Classes

Code

public function process(File $phpcsFile, $openTagPointer) : void {
    if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) {
        return;
    }
    $tokens = $phpcsFile->getTokens();
    $referencedNames = array_merge(ReferencedNameHelper::getAllReferencedNames($phpcsFile, $openTagPointer), ReferencedNameHelper::getAllReferencedNamesInAttributes($phpcsFile, $openTagPointer));
    foreach ($referencedNames as $referencedName) {
        if (!$referencedName->isClass()) {
            continue;
        }
        $anonymousClassPointer = TokenHelper::findPrevious($phpcsFile, T_ANON_CLASS, $referencedName->getStartPointer() - 1);
        if ($anonymousClassPointer !== null && $tokens[$anonymousClassPointer]['scope_closer'] > $referencedName->getEndPointer()) {
            continue;
        }
        $classPointer = ClassHelper::getClassPointer($phpcsFile, $referencedName->getStartPointer());
        if ($classPointer === null) {
            continue;
        }
        $className = ClassHelper::getFullyQualifiedName($phpcsFile, $classPointer);
        $resolvedName = NamespaceHelper::resolveClassName($phpcsFile, $referencedName->getNameAsReferencedInFile(), $referencedName->getStartPointer());
        if ($className !== $resolvedName) {
            continue;
        }
        $fix = $phpcsFile->addFixableError('"self" for local reference is required.', $referencedName->getStartPointer(), self::CODE_REQUIRED_SELF_REFERENCE);
        if (!$fix) {
            continue;
        }
        $inAttribute = $tokens[$referencedName->getStartPointer()]['code'] === T_ATTRIBUTE;
        $phpcsFile->fixer
            ->beginChangeset();
        if ($inAttribute) {
            $attributeContent = TokenHelper::getContent($phpcsFile, $referencedName->getStartPointer(), $referencedName->getEndPointer());
            $fixedAttributeContent = preg_replace('~(?<=\\W)' . preg_quote($referencedName->getNameAsReferencedInFile(), '~') . '(?=\\W)~', 'self', $attributeContent);
            $phpcsFile->fixer
                ->replaceToken($referencedName->getStartPointer(), $fixedAttributeContent);
        }
        else {
            $phpcsFile->fixer
                ->replaceToken($referencedName->getStartPointer(), 'self');
        }
        FixerHelper::removeBetweenIncluding($phpcsFile, $referencedName->getStartPointer() + 1, $referencedName->getEndPointer());
        $phpcsFile->fixer
            ->endChangeset();
    }
}

API Navigation

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