?HAMA

Navigation

Breadcrumbs

Create

Edit File Size: 1.29 KB

/opt/cpanel/ea-wappspector/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DeprecatedAnnotationDeclarationSniff.php

Text Base64

<?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,
			);
		}
	}

}

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
AbstractRequireOneLineDocComment.php	3.55 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
AnnotationNameSniff.php	6.93 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
DeprecatedAnnotationDeclarationSniff.php	1.29 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
DisallowCommentAfterCodeSniff.php	4.77 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
DisallowOneLinePropertyDocCommentSniff.php	2.65 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
DocCommentSpacingSniff.php	25.19 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
EmptyCommentSniff.php	6.25 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
ForbiddenAnnotationsSniff.php	3.83 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
ForbiddenCommentsSniff.php	3.63 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
InlineDocCommentDeclarationSniff.php	13.98 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
RequireOneLineDocCommentSniff.php	568 B	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
RequireOneLinePropertyDocCommentSniff.php	1.89 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
UselessFunctionDocCommentSniff.php	3.95 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive
UselessInheritDocCommentSniff.php	3.13 KB	lrw-r--r--	2025-09-13 08:53:30	Edit Download recursive recursive

Directory Contents