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

Breadcrumb

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

class BlockControlStructureSpacingSniff

Hierarchy

  • class \SlevomatCodingStandard\Sniffs\ControlStructures\AbstractControlStructureSpacing implements \PHP_CodeSniffer\Sniffs\Sniff
    • class \SlevomatCodingStandard\Sniffs\ControlStructures\BlockControlStructureSpacingSniff extends \SlevomatCodingStandard\Sniffs\ControlStructures\AbstractControlStructureSpacing

Expanded class hierarchy of BlockControlStructureSpacingSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/BlockControlStructureSpacingSniff.php, line 13

Namespace

SlevomatCodingStandard\Sniffs\ControlStructures
View source
class BlockControlStructureSpacingSniff extends AbstractControlStructureSpacing {
    
    /** @var int */
    public $linesCountBefore = 1;
    
    /** @var int */
    public $linesCountBeforeFirst = 0;
    
    /** @var int */
    public $linesCountAfter = 1;
    
    /** @var int */
    public $linesCountAfterLast = 0;
    
    /** @var list<string> */
    public $controlStructures = [];
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $controlStructurePointer
     */
    public function process(File $phpcsFile, $controlStructurePointer) : void {
        $this->linesCountBefore = SniffSettingsHelper::normalizeInteger($this->linesCountBefore);
        $this->linesCountBeforeFirst = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirst);
        $this->linesCountAfter = SniffSettingsHelper::normalizeInteger($this->linesCountAfter);
        $this->linesCountAfterLast = SniffSettingsHelper::normalizeInteger($this->linesCountAfterLast);
        if ($this->isWhilePartOfDo($phpcsFile, $controlStructurePointer)) {
            return;
        }
        parent::process($phpcsFile, $controlStructurePointer);
    }
    
    /**
     * @return list<string>
     */
    protected function getSupportedKeywords() : array {
        return [
            self::KEYWORD_IF,
            self::KEYWORD_DO,
            self::KEYWORD_WHILE,
            self::KEYWORD_FOR,
            self::KEYWORD_FOREACH,
            self::KEYWORD_SWITCH,
            self::KEYWORD_TRY,
            self::KEYWORD_CASE,
            self::KEYWORD_DEFAULT,
        ];
    }
    
    /**
     * @return list<string>
     */
    protected function getKeywordsToCheck() : array {
        return $this->controlStructures;
    }
    protected function getLinesCountBefore() : int {
        return $this->linesCountBefore;
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter
     */
    protected function getLinesCountBeforeFirst(File $phpcsFile, int $controlStructurePointer) : int {
        return $this->linesCountBeforeFirst;
    }
    protected function getLinesCountAfter() : int {
        return $this->linesCountAfter;
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter
     */
    protected function getLinesCountAfterLast(File $phpcsFile, int $controlStructurePointer, int $controlStructureEndPointer) : int {
        return $this->linesCountAfterLast;
    }
    private function isWhilePartOfDo(File $phpcsFile, int $controlStructurePointer) : bool {
        $tokens = $phpcsFile->getTokens();
        $pointerBefore = TokenHelper::findPreviousEffective($phpcsFile, $controlStructurePointer - 1);
        return $tokens[$controlStructurePointer]['code'] === T_WHILE && $tokens[$pointerBefore]['code'] === T_CLOSE_CURLY_BRACKET && array_key_exists('scope_condition', $tokens[$pointerBefore]) && $tokens[$tokens[$pointerBefore]['scope_condition']]['code'] === T_DO;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractControlStructureSpacing::$tokensToCheck private property @var array&lt;(string|int)&gt;|null
AbstractControlStructureSpacing::checkLinesAfter protected function 1
AbstractControlStructureSpacing::checkLinesBefore protected function 1
AbstractControlStructureSpacing::CODE_INCORRECT_LINES_COUNT_AFTER_CONTROL_STRUCTURE public constant
AbstractControlStructureSpacing::CODE_INCORRECT_LINES_COUNT_AFTER_LAST_CONTROL_STRUCTURE public constant
AbstractControlStructureSpacing::CODE_INCORRECT_LINES_COUNT_BEFORE_CONTROL_STRUCTURE public constant
AbstractControlStructureSpacing::CODE_INCORRECT_LINES_COUNT_BEFORE_FIRST_CONTROL_STRUCTURE public constant
AbstractControlStructureSpacing::findControlStructureEnd private function
AbstractControlStructureSpacing::getTokensToCheck private function *
AbstractControlStructureSpacing::KEYWORD_BREAK protected constant
AbstractControlStructureSpacing::KEYWORD_CASE protected constant
AbstractControlStructureSpacing::KEYWORD_CONTINUE protected constant
AbstractControlStructureSpacing::KEYWORD_DEFAULT protected constant
AbstractControlStructureSpacing::KEYWORD_DO protected constant
AbstractControlStructureSpacing::KEYWORD_FOR protected constant
AbstractControlStructureSpacing::KEYWORD_FOREACH protected constant
AbstractControlStructureSpacing::KEYWORD_GOTO protected constant
AbstractControlStructureSpacing::KEYWORD_IF protected constant
AbstractControlStructureSpacing::KEYWORD_PARENT protected constant
AbstractControlStructureSpacing::KEYWORD_RETURN protected constant
AbstractControlStructureSpacing::KEYWORD_SWITCH protected constant
AbstractControlStructureSpacing::KEYWORD_THROW protected constant
AbstractControlStructureSpacing::KEYWORD_TRY protected constant
AbstractControlStructureSpacing::KEYWORD_WHILE protected constant
AbstractControlStructureSpacing::KEYWORD_YIELD protected constant
AbstractControlStructureSpacing::KEYWORD_YIELD_FROM protected constant
AbstractControlStructureSpacing::register public function * Overrides Sniff::register
BlockControlStructureSpacingSniff::$controlStructures public property @var list&lt;string&gt;
BlockControlStructureSpacingSniff::$linesCountAfter public property @var int
BlockControlStructureSpacingSniff::$linesCountAfterLast public property @var int
BlockControlStructureSpacingSniff::$linesCountBefore public property @var int
BlockControlStructureSpacingSniff::$linesCountBeforeFirst public property @var int
BlockControlStructureSpacingSniff::getKeywordsToCheck protected function * Overrides AbstractControlStructureSpacing::getKeywordsToCheck
BlockControlStructureSpacingSniff::getLinesCountAfter protected function Overrides AbstractControlStructureSpacing::getLinesCountAfter
BlockControlStructureSpacingSniff::getLinesCountAfterLast protected function * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter Overrides AbstractControlStructureSpacing::getLinesCountAfterLast
BlockControlStructureSpacingSniff::getLinesCountBefore protected function Overrides AbstractControlStructureSpacing::getLinesCountBefore
BlockControlStructureSpacingSniff::getLinesCountBeforeFirst protected function * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter Overrides AbstractControlStructureSpacing::getLinesCountBeforeFirst
BlockControlStructureSpacingSniff::getSupportedKeywords protected function * Overrides AbstractControlStructureSpacing::getSupportedKeywords
BlockControlStructureSpacingSniff::isWhilePartOfDo private function
BlockControlStructureSpacingSniff::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides AbstractControlStructureSpacing::process
RSS feed
Powered by Drupal