function ForbiddenAnnotationsSniff::process

* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

Parameters

int $docCommentOpenPointer:

Overrides Sniff::process

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenAnnotationsSniff.php, line 45

Class

ForbiddenAnnotationsSniff

Namespace

SlevomatCodingStandard\Sniffs\Commenting

Code

public function process(File $phpcsFile, $docCommentOpenPointer) : void {
    $tokens = $phpcsFile->getTokens();
    $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer);
    foreach ($annotations as $annotation) {
        if (!in_array($annotation->getName(), $this->getNormalizedForbiddenAnnotations(), true)) {
            continue;
        }
        $fix = $phpcsFile->addFixableError(sprintf('Use of annotation %s is forbidden.', $annotation->getName()), $annotation->getStartPointer(), self::CODE_ANNOTATION_FORBIDDEN);
        if (!$fix) {
            continue;
        }
        $starPointer = TokenHelper::findPrevious($phpcsFile, T_DOC_COMMENT_STAR, $annotation->getStartPointer() - 1, $docCommentOpenPointer);
        $annotationStartPointer = $starPointer ?? $annotation->getStartPointer();
        
        /** @var int $nextPointer */
        $nextPointer = TokenHelper::findNext($phpcsFile, [
            T_DOC_COMMENT_TAG,
            T_DOC_COMMENT_CLOSE_TAG,
        ], $annotation->getEndPointer() + 1);
        if ($tokens[$nextPointer]['code'] === T_DOC_COMMENT_TAG) {
            $nextPointer = TokenHelper::findPrevious($phpcsFile, T_DOC_COMMENT_STAR, $nextPointer - 1);
        }
        $annotationEndPointer = $nextPointer - 1;
        if ($tokens[$nextPointer]['code'] === T_DOC_COMMENT_CLOSE_TAG && $starPointer !== null) {
            $pointerBeforeWhitespace = TokenHelper::findPreviousExcluding($phpcsFile, [
                T_DOC_COMMENT_WHITESPACE,
                T_DOC_COMMENT_STAR,
            ], $annotationStartPointer - 1);
            
            /** @var int $annotationStartPointer */
            $annotationStartPointer = TokenHelper::findNext($phpcsFile, T_DOC_COMMENT_STAR, $pointerBeforeWhitespace + 1);
        }
        $phpcsFile->fixer
            ->beginChangeset();
        FixerHelper::removeBetweenIncluding($phpcsFile, $annotationStartPointer, $annotationEndPointer);
        $docCommentUseful = false;
        $docCommentClosePointer = $tokens[$docCommentOpenPointer]['comment_closer'];
        for ($i = $docCommentOpenPointer + 1; $i < $docCommentClosePointer; $i++) {
            $tokenContent = trim($phpcsFile->fixer
                ->getTokenContent($i));
            if ($tokenContent === '' || $tokenContent === '*') {
                continue;
            }
            $docCommentUseful = true;
            break;
        }
        if (!$docCommentUseful) {
            
            /** @var int $nextPointerAfterDocComment */
            $nextPointerAfterDocComment = TokenHelper::findNextEffective($phpcsFile, $docCommentClosePointer + 1);
            FixerHelper::removeBetweenIncluding($phpcsFile, $docCommentOpenPointer, $nextPointerAfterDocComment - 1);
        }
        $phpcsFile->fixer
            ->endChangeset();
    }
}