Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. EnumCaseSpacingSniff.php

class EnumCaseSpacingSniff

Hierarchy

  • class \SlevomatCodingStandard\Sniffs\Classes\AbstractPropertyConstantAndEnumCaseSpacing implements \PHP_CodeSniffer\Sniffs\Sniff
    • class \SlevomatCodingStandard\Sniffs\Classes\EnumCaseSpacingSniff extends \SlevomatCodingStandard\Sniffs\Classes\AbstractPropertyConstantAndEnumCaseSpacing

Expanded class hierarchy of EnumCaseSpacingSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/EnumCaseSpacingSniff.php, line 14

Namespace

SlevomatCodingStandard\Sniffs\Classes
View source
class EnumCaseSpacingSniff extends AbstractPropertyConstantAndEnumCaseSpacing {
    public const CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_ENUM_CASE = 'IncorrectCountOfBlankLinesAfterEnumCase';
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_ENUM_CASE,
        ];
    }
    protected function isNextMemberValid(File $phpcsFile, int $pointer) : bool {
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$pointer]['code'] === T_ENUM_CASE) {
            return true;
        }
        $nextPointer = TokenHelper::findNext($phpcsFile, [
            T_FUNCTION,
            T_CONST,
            T_VARIABLE,
            T_USE,
            T_ENUM_CASE,
        ], $pointer + 1);
        return $tokens[$nextPointer]['code'] === T_ENUM_CASE;
    }
    protected function addError(File $phpcsFile, int $pointer, int $minExpectedLines, int $maxExpectedLines, int $found) : bool {
        if ($minExpectedLines === $maxExpectedLines) {
            $errorMessage = $minExpectedLines === 1 ? 'Expected 1 blank line after enum case, found %3$d.' : 'Expected %2$d blank lines after enum case, found %3$d.';
        }
        else {
            $errorMessage = 'Expected %1$d to %2$d blank lines after enum case, found %3$d.';
        }
        $error = sprintf($errorMessage, $minExpectedLines, $maxExpectedLines, $found);
        return $phpcsFile->addFixableError($error, $pointer, self::CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_ENUM_CASE);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractPropertyConstantAndEnumCaseSpacing::$maxLinesCountBeforeWithComment public property @var int
AbstractPropertyConstantAndEnumCaseSpacing::$maxLinesCountBeforeWithoutComment public property @var int
AbstractPropertyConstantAndEnumCaseSpacing::$minLinesCountBeforeWithComment public property @var int
AbstractPropertyConstantAndEnumCaseSpacing::$minLinesCountBeforeWithoutComment public property @var int
AbstractPropertyConstantAndEnumCaseSpacing::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides Sniff::process 2
EnumCaseSpacingSniff::addError protected function Overrides AbstractPropertyConstantAndEnumCaseSpacing::addError
EnumCaseSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_ENUM_CASE public constant
EnumCaseSpacingSniff::isNextMemberValid protected function Overrides AbstractPropertyConstantAndEnumCaseSpacing::isNextMemberValid
EnumCaseSpacingSniff::register public function * Overrides Sniff::register

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal