DeprecatedAnnotationDeclarationSniff.php

<?php

declare (strict_types=1);
namespace SlevomatCodingStandard\Sniffs\Commenting;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHPStan\PhpDocParser\Ast\PhpDoc\DeprecatedTagValueNode;
use SlevomatCodingStandard\Helpers\Annotation;
use SlevomatCodingStandard\Helpers\AnnotationHelper;
use function count;
use const T_DOC_COMMENT_OPEN_TAG;
class DeprecatedAnnotationDeclarationSniff implements Sniff {
    public const MISSING_DESCRIPTION = 'MissingDescription';
    
    /** @return array<int, (int|string)> */
    public function register() : array {
        return [
            T_DOC_COMMENT_OPEN_TAG,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $docCommentStartPointer
     */
    public function process(File $phpcsFile, $docCommentStartPointer) : void {
        
        /** @var list<Annotation<DeprecatedTagValueNode>> $annotations */
        $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentStartPointer, '@deprecated');
        if (count($annotations) === 0) {
            return;
        }
        foreach ($annotations as $annotation) {
            if ($annotation->getValue()->description !== '') {
                continue;
            }
            $phpcsFile->addError('Deprecated annotation must have a description.', $annotation->getStartPointer(), self::MISSING_DESCRIPTION);
        }
    }

}