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

Breadcrumb

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

class ParentCallSpacingSniff

Hierarchy

  • class \SlevomatCodingStandard\Sniffs\ControlStructures\AbstractControlStructureSpacing implements \PHP_CodeSniffer\Sniffs\Sniff
    • class \SlevomatCodingStandard\Sniffs\Classes\ParentCallSpacingSniff extends \SlevomatCodingStandard\Sniffs\ControlStructures\AbstractControlStructureSpacing

Expanded class hierarchy of ParentCallSpacingSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ParentCallSpacingSniff.php, line 25

Namespace

SlevomatCodingStandard\Sniffs\Classes
View source
class ParentCallSpacingSniff extends AbstractControlStructureSpacing {
    
    /** @var int */
    public $linesCountBefore = 1;
    
    /** @var int */
    public $linesCountBeforeFirst = 0;
    
    /** @var int */
    public $linesCountAfter = 1;
    
    /** @var int */
    public $linesCountAfterLast = 0;
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $parentPointer
     */
    public function process(File $phpcsFile, $parentPointer) : 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);
        $tokens = $phpcsFile->getTokens();
        if (array_key_exists('nested_parenthesis', $tokens[$parentPointer])) {
            return;
        }
        $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $parentPointer - 1);
        if (in_array($tokens[$previousPointer]['code'], array_merge(Tokens::$castTokens, [
            T_ASPERAND,
        ]), true)) {
            $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1);
        }
        $tokensToIgnore = array_merge(Tokens::$assignmentTokens, Tokens::$equalityTokens, Tokens::$booleanOperators, [
            T_RETURN,
            T_YIELD,
            T_YIELD_FROM,
            T_COLON,
            T_STRING_CONCAT,
            T_INLINE_THEN,
            T_INLINE_ELSE,
            T_COALESCE,
            T_MATCH_ARROW,
        ]);
        if (in_array($tokens[$previousPointer]['code'], $tokensToIgnore, true)) {
            return;
        }
        $previousShortArrayOpenerPointer = TokenHelper::findPrevious($phpcsFile, T_OPEN_SHORT_ARRAY, $parentPointer - 1);
        if ($previousShortArrayOpenerPointer !== null && $tokens[$previousShortArrayOpenerPointer]['bracket_closer'] > $parentPointer) {
            return;
        }
        parent::process($phpcsFile, $parentPointer);
    }
    
    /**
     * @return list<string>
     */
    protected function getSupportedKeywords() : array {
        return [
            self::KEYWORD_PARENT,
        ];
    }
    
    /**
     * @return list<string>
     */
    protected function getKeywordsToCheck() : array {
        return [
            self::KEYWORD_PARENT,
        ];
    }
    protected function getLinesCountBefore() : int {
        return $this->linesCountBefore;
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter
     */
    protected function getLinesCountBeforeFirst(File $phpcsFile, int $parentPointer) : int {
        return $this->linesCountBeforeFirst;
    }
    protected function getLinesCountAfter() : int {
        return $this->linesCountAfter;
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter
     */
    protected function getLinesCountAfterLast(File $phpcsFile, int $parentPointer, int $parentEndPointer) : int {
        return $this->linesCountAfterLast;
    }

}

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
ParentCallSpacingSniff::$linesCountAfter public property @var int
ParentCallSpacingSniff::$linesCountAfterLast public property @var int
ParentCallSpacingSniff::$linesCountBefore public property @var int
ParentCallSpacingSniff::$linesCountBeforeFirst public property @var int
ParentCallSpacingSniff::getKeywordsToCheck protected function * Overrides AbstractControlStructureSpacing::getKeywordsToCheck
ParentCallSpacingSniff::getLinesCountAfter protected function Overrides AbstractControlStructureSpacing::getLinesCountAfter
ParentCallSpacingSniff::getLinesCountAfterLast protected function * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter Overrides AbstractControlStructureSpacing::getLinesCountAfterLast
ParentCallSpacingSniff::getLinesCountBefore protected function Overrides AbstractControlStructureSpacing::getLinesCountBefore
ParentCallSpacingSniff::getLinesCountBeforeFirst protected function * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter Overrides AbstractControlStructureSpacing::getLinesCountBeforeFirst
ParentCallSpacingSniff::getSupportedKeywords protected function * Overrides AbstractControlStructureSpacing::getSupportedKeywords
ParentCallSpacingSniff::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides AbstractControlStructureSpacing::process
RSS feed
Powered by Drupal