?HAMA

Edit File Size: 3.83 KB

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

Text Base64

<?php declare(strict_types = 1);

namespace SlevomatCodingStandard\Sniffs\Commenting;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\AnnotationHelper;
use SlevomatCodingStandard\Helpers\FixerHelper;
use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use function in_array;
use function sprintf;
use function trim;
use const T_DOC_COMMENT_CLOSE_TAG;
use const T_DOC_COMMENT_OPEN_TAG;
use const T_DOC_COMMENT_STAR;
use const T_DOC_COMMENT_TAG;
use const T_DOC_COMMENT_WHITESPACE;

class ForbiddenAnnotationsSniff implements Sniff
{

public const CODE_ANNOTATION_FORBIDDEN = 'AnnotationForbidden';

/** @var list<string> */
	public array $forbiddenAnnotations = [];

/** @var list<string>|null */
	private ?array $normalizedForbiddenAnnotations = null;

/**
	 * @return array<int, (int|string)>
	 */
	public function register(): array
	{
		return [
			T_DOC_COMMENT_OPEN_TAG,
		];
	}

/**
	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
	 * @param int $docCommentOpenPointer
	 */
	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();
		}
	}

/**
	 * @return list<string>
	 */
	private function getNormalizedForbiddenAnnotations(): array
	{
		$this->normalizedForbiddenAnnotations ??= SniffSettingsHelper::normalizeArray($this->forbiddenAnnotations);
		return $this->normalizedForbiddenAnnotations;
	}

}

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