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

Breadcrumb

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

class ConstantSpacingSniff

Hierarchy

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

Expanded class hierarchy of ConstantSpacingSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ConstantSpacingSniff.php, line 18

Namespace

SlevomatCodingStandard\Sniffs\Classes
View source
class ConstantSpacingSniff extends AbstractPropertyConstantAndEnumCaseSpacing {
    public const CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_CONSTANT = 'IncorrectCountOfBlankLinesAfterConstant';
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_CONST,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $constantPointer
     */
    public function process(File $phpcsFile, $constantPointer) : int {
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$constantPointer]['conditions'] === []) {
            return $constantPointer;
        }
        
        /** @var int $classPointer */
        $classPointer = array_keys($tokens[$constantPointer]['conditions'])[count($tokens[$constantPointer]['conditions']) - 1];
        if (!in_array($tokens[$classPointer]['code'], Tokens::$ooScopeTokens, true)) {
            return $constantPointer;
        }
        return parent::process($phpcsFile, $constantPointer);
    }
    protected function isNextMemberValid(File $phpcsFile, int $pointer) : bool {
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$pointer]['code'] === T_CONST) {
            return true;
        }
        $nextPointer = TokenHelper::findNext($phpcsFile, [
            T_FUNCTION,
            T_ENUM_CASE,
            T_CONST,
            T_VARIABLE,
            T_USE,
        ], $pointer + 1);
        return $tokens[$nextPointer]['code'] === T_CONST;
    }
    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 constant, found %3$d.' : 'Expected %2$d blank lines after constant, found %3$d.';
        }
        else {
            $errorMessage = 'Expected %1$d to %2$d blank lines after constant, found %3$d.';
        }
        $error = sprintf($errorMessage, $minExpectedLines, $maxExpectedLines, $found);
        return $phpcsFile->addFixableError($error, $pointer, self::CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_CONSTANT);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
AbstractPropertyConstantAndEnumCaseSpacing::$maxLinesCountBeforeWithComment public property @var int
AbstractPropertyConstantAndEnumCaseSpacing::$maxLinesCountBeforeWithoutComment public property @var int
AbstractPropertyConstantAndEnumCaseSpacing::$minLinesCountBeforeWithComment public property @var int
AbstractPropertyConstantAndEnumCaseSpacing::$minLinesCountBeforeWithoutComment public property @var int
ConstantSpacingSniff::addError protected function Overrides AbstractPropertyConstantAndEnumCaseSpacing::addError
ConstantSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_CONSTANT public constant
ConstantSpacingSniff::isNextMemberValid protected function Overrides AbstractPropertyConstantAndEnumCaseSpacing::isNextMemberValid
ConstantSpacingSniff::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides AbstractPropertyConstantAndEnumCaseSpacing::process
ConstantSpacingSniff::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