ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: opt / cpanel / ea-wappspector / vendor / slevomat / coding-standard / SlevomatCodingStandard / Sniffs / Classes

<?php declare(strict_types = 1);

namespace SlevomatCodingStandard\Sniffs\Classes;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\FixerHelper;
use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use function sprintf;
use function str_repeat;
use function strlen;
use const T_COLON;
use const T_ENUM;

class BackedEnumTypeSpacingSniff implements Sniff
{

public const CODE_INCORRECT_SPACES_BEFORE_COLON = 'IncorrectSpacesBeforeColon';

public const CODE_INCORRECT_SPACES_BEFORE_TYPE = 'IncorrectSpacesBeforeType';

public int $spacesCountBeforeColon = 0;

public int $spacesCountBeforeType = 1;

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

/**
	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
	 * @param int $enumPointer
	 */
	public function process(File $phpcsFile, $enumPointer): void
	{
		$this->spacesCountBeforeColon = SniffSettingsHelper::normalizeInteger($this->spacesCountBeforeColon);
		$this->spacesCountBeforeType = SniffSettingsHelper::normalizeInteger($this->spacesCountBeforeType);

$tokens = $phpcsFile->getTokens();

$colonPointer = TokenHelper::findNext($phpcsFile, T_COLON, $enumPointer + 1, $tokens[$enumPointer]['scope_opener']);

if ($colonPointer === null) {
			return;
		}

$this->checkSpacesBeforeColon($phpcsFile, $colonPointer);
		$this->checkSpacesBeforeType($phpcsFile, $colonPointer);
	}

public function checkSpacesBeforeColon(File $phpcsFile, int $colonPointer): void
	{
		$namePointer = TokenHelper::findPreviousEffective($phpcsFile, $colonPointer - 1);

$whitespace = TokenHelper::getContent($phpcsFile, $namePointer + 1, $colonPointer - 1);

if ($this->spacesCountBeforeColon === strlen($whitespace)) {
			return;
		}

$fix = $phpcsFile->addFixableError(
			$this->formatErrorMessage('before colon', $this->spacesCountBeforeColon),
			$colonPointer,
			self::CODE_INCORRECT_SPACES_BEFORE_COLON,
		);
		if (!$fix) {
			return;
		}

$phpcsFile->fixer->beginChangeset();

FixerHelper::removeBetween($phpcsFile, $namePointer, $colonPointer);

FixerHelper::addBefore($phpcsFile, $colonPointer, str_repeat(' ', $this->spacesCountBeforeColon));

$phpcsFile->fixer->endChangeset();
	}

public function checkSpacesBeforeType(File $phpcsFile, int $colonPointer): void
	{
		$typePointer = TokenHelper::findNextEffective($phpcsFile, $colonPointer + 1);

$whitespace = TokenHelper::getContent($phpcsFile, $colonPointer + 1, $typePointer - 1);

if ($this->spacesCountBeforeType === strlen($whitespace)) {
			return;
		}

$fix = $phpcsFile->addFixableError(
			$this->formatErrorMessage('before type', $this->spacesCountBeforeType),
			$typePointer,
			self::CODE_INCORRECT_SPACES_BEFORE_TYPE,
		);
		if (!$fix) {
			return;
		}

$phpcsFile->fixer->beginChangeset();

FixerHelper::removeBetween($phpcsFile, $colonPointer, $typePointer);

FixerHelper::addBefore($phpcsFile, $typePointer, str_repeat(' ', $this->spacesCountBeforeType));

$phpcsFile->fixer->endChangeset();
	}

private function formatErrorMessage(string $suffix, int $requiredSpaces): string
	{
		return $requiredSpaces === 0
			? sprintf('There must be no whitespace %s.', $suffix)
			: sprintf('There must be exactly %d whitespace%s %s.', $requiredSpaces, $requiredSpaces !== 1 ? 's' : '', $suffix);
	}

}

[-] MethodSpacingSniff.php [edit]
[-] PropertySpacingSniff.php [edit]
[-] EmptyLinesAroundClassBracesSniff.php [edit]
[-] ClassLengthSniff.php [edit]
[-] DisallowConstructorPropertyPromotionSniff.php [edit]
[+] ..
[-] AbstractPropertyConstantAndEnumCaseSpacing.php [edit]
[-] ParentCallSpacingSniff.php [edit]
[-] RequireAbstractOrFinalSniff.php [edit]
[-] RequireSelfReferenceSniff.php [edit]
[-] RequireConstructorPropertyPromotionSniff.php [edit]
[-] TraitUseDeclarationSniff.php [edit]
[-] ConstantSpacingSniff.php [edit]
[-] ForbiddenPublicPropertySniff.php [edit]
[-] ClassStructureSniff.php [edit]
[-] BackedEnumTypeSpacingSniff.php [edit]
[-] UnsupportedClassGroupException.php [edit]
[-] SuperfluousAbstractClassNamingSniff.php [edit]
[-] ClassConstantVisibilitySniff.php [edit]
[-] SuperfluousTraitNamingSniff.php [edit]
[-] SuperfluousExceptionNamingSniff.php [edit]
[-] UselessLateStaticBindingSniff.php [edit]
[-] AbstractMethodSignature.php [edit]
[-] TraitUseSpacingSniff.php [edit]
[-] DisallowMultiPropertyDefinitionSniff.php [edit]
[-] SuperfluousErrorNamingSniff.php [edit]
[-] DisallowStringExpressionPropertyFetchSniff.php [edit]
[-] SuperfluousInterfaceNamingSniff.php [edit]
[-] RequireSingleLineMethodSignatureSniff.php [edit]
[-] DisallowLateStaticBindingForConstantsSniff.php [edit]
[-] RequireMultiLineMethodSignatureSniff.php [edit]
[-] PropertyDeclarationSniff.php [edit]
[-] ClassMemberSpacingSniff.php [edit]
[-] MissingClassGroupsException.php [edit]
[-] DisallowMultiConstantDefinitionSniff.php [edit]
[-] EnumCaseSpacingSniff.php [edit]
[-] ModernClassNameReferenceSniff.php [edit]